Simcenter Flomaster User Guide: Software Version 2020.2 October 2020

Simcenter Flomaster™ User Guide
Software Version 2020.2

October 2020
Unpublished work. © Siemens 2020
This document contains information that is confidential and proprietary to Mentor Graphics Corporation, Siemens
Industry Software Inc., or their affiliates (collectively, "Siemens"). The original recipient of this document may
duplicate this document in whole or in part for internal business purposes only, provided that this entire notice
appears in all copies. In duplicating any part of this document, the recipient agrees to make every reasonable effort
to prevent the unauthorized use and distribution of the confidential and proprietary information.
This document is for information and instruction purposes. Siemens reserves the right to make changes in
specifications and other information contained in this publication without prior notice, and the reader should, in all
cases, consult Siemens to determine whether any changes have been made.
The terms and conditions governing the sale and licensing of Siemens products are set forth in written agreements
between Siemens and its customers.
No representation or other affirmation of fact contained in this publication shall be deemed to be a warranty or give
rise to any liability of Siemens whatsoever.
SIEMENS MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
AND NON-INFRINGEMENT OF INTELLECTUAL PROPERTY.
SIEMENS SHALL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL OR
PUNITIVE DAMAGES, LOST DATA OR PROFITS, EVEN IF SUCH DAMAGES WERE FORESEEABLE, ARISING
OUT OF OR RELATED TO THIS PUBLICATION OR THE INFORMATION CONTAINED IN IT, EVEN IF SIEMENS
HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
LICENSE RIGHTS APPLICABLE TO THE U.S. GOVERNMENT: This document explains the capabilities of
commercial products that were developed exclusively at private expense. If the products are acquired directly or
indirectly for use by the U.S. Government, then the parties agree that the products and this document are
considered "Commercial Items" and "Commercial Computer Software" or "Computer Software Documentation," as
defined in 48 C.F.R. §2.101 and 48 C.F.R. §252.227-7014(a)(1) and (a)(5), as applicable. Software and this
document may only be used under the terms and conditions of the applicable license agreement with Siemens as
required by 48 C.F.R. §12.212 and 48 C.F.R §227.7202. The U.S. Government will only have the rights set forth in
the End User License Agreement, which supersedes any conflicting terms or conditions in any government order
document, except for provisions which are contrary to applicable mandatory federal laws.
TRADEMARKS: The trademarks, logos and service marks ("Marks") used herein are the property of Siemens or
other parties. No one is permitted to use these Marks without the prior written consent of Siemens or the owner of
the Marks, as applicable. The use herein of third party Marks is not an attempt to indicate Siemens as a source of a
product, but is intended to indicate a product from, or associated with, a particular third party. A list of Siemens'
trademarks may be viewed at: www.plm.automation.siemens.com/global/en/legal/trademarks.html and
mentor.com/trademarks.
The registered trademark Linux® is used pursuant to a sublicense from LMI, the exclusive licensee of Linus
Torvalds, owner of the mark on a world-wide basis.
Support Center: support.sw.siemens.com

Send Feedback on Documentation: support.sw.siemens.com/doc_feedback_form
Table of Contents
Chapter 1
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Starting Simcenter Flomaster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Application Window Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Window Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Logon Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Database Space Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Configuration Utility Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Logon and Startup Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Chapter 2
Working With Simcenter Flomaster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Logging on as a Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Changing Your Logon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Elevating or Reducing Your Role. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Chapter 3
Managing and Working with Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Creating a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Deleting a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Sharing Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapter 4
Managing and Working with Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
About Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Creating Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Copying and Moving Networks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Deleting a Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Searching for Items in the Network Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Attaching Items to Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Viewing, Editing, and Deleting Items Attached to Networks . . . . . . . . . . . . . . . . . . . . . . . . 59
Sample Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Exploring Sample Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Creating Your Own Sample Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Simcenter Flomaster™ User Guide, v2020.2 3

October 2020
Table of Contents
Deleting Sample Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Network Window Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Configuring the Network Drawing window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Schematic Configuration Dialog Box - General Options Tab . . . . . . . . . . . . . . . . . . . . . . 67
Schematic Configuration Dialog Box - Setting the Pipe Properties . . . . . . . . . . . . . . . . . . 68
Schematic Configuration Dialog Box - Colour Control . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Schematic Configuration Dialog Box - Importing Background Images . . . . . . . . . . . . . . 70
Using the Rendering Configuration Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Adding Text, Lines and Boxes to Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Adding and Managing Network Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Inserting a Comment in the Network Drawing window . . . . . . . . . . . . . . . . . . . . . . . . . 74
Moving Comments and Text Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Displaying and Suppressing Component Names and IDs . . . . . . . . . . . . . . . . . . . . . . . . 75
Displaying and Suppressing Node Names and IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Text Alignment Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Adding and Managing Lines and Boxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Chapter 5
Modeling Networks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Networks - Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Network Modeling Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Incompressible (Non-Hydraulic Power) Modeling Rules . . . . . . . . . . . . . . . . . . . . . . . . . 81
Compressible Flow Modeling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Compressible Flow Modeling Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Using Compressible Flow Transient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Improving Compressible Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Compressible Transient - Solution Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Hydraulic Power Modeling Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Components, Nodes, and Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Accessing Components and Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Building a Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Adding Components to a Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Switching the Snap To Grid On or Off. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Rotating Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Aligning Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Renumbering Components and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Moving Around the Network Drawing window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Zooming in and Out of the Network Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Using the Network Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Using the Catalogue Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Showing the Catalogue Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Connecting Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Connections and Their Meanings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Copying Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Deleting Components and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
4 Simcenter Flomaster™ User Guide, v2020.2

October 2020
Table of Contents
Replacing Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Component Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Setting Component Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Using the Collection List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Layer Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
About Layers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Adding a Circuit to a Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
The Layer Manager Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Using the Layer Manager - Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Chapter 6
Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Running a Simulation - Overview of the Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Overview of the Simulation Differences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Simulation Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Setting the General Simulation Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Setting the Ambient Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Setting the Convergence & Tolerance Criteria. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Setting the Default Material . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Setting the Output Control Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Setting the Fluid Properties Caching Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Setting the Pipe Profile Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Running a Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Using Data from Previous Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Resolving Simulation Failures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Aerospace Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
What Simulations Can be Run? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Running Aerospace Simulations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Aerospace Error and Warning Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Turbine Simulations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Gas Turbine Simulation Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Running Turbine Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
About Swirl Effects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Swirl Effects - Node Y Coordinate - Data Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Velocity Vectors and Impingement Losses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Turbine Simulations - Velocity Vector Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Turbine Simulations - Impingement Losses Calculations . . . . . . . . . . . . . . . . . . . . . . . . 175
Restart Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Considerations for Restart Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Restart with No Time Step Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Restart with Simulation Time Step Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Creating a Restart File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Creating a Random Time Restart File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Creating a Sequential Time Restart File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Serialized Restart File Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Running a Restart Simulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Geometric Heat Exchanger Wizard - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Geometric Heat Exchanger Wizard - Scripts and Data Structure. . . . . . . . . . . . . . . . . . . . 193

October 2020
Table of Contents
Geometric Heat Exchanger Wizard - Connectivity Examples . . . . . . . . . . . . . . . . . . . . . . 195

Using the Geometric Heat Exchanger Wizard - Creating a Generic Heat Exchanger . . . . 198
Using the Geometric Heat Exchanger Wizard - Creating a Fin and Tube Heat Exchanger 204
Using the Geometric Heat Exchanger Wizard - Creating a Serpentine Fin and Tube Heat
Exchanger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Hydraulic Gradient Lines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Hydraulic Gradient Line - Worked Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Using the Time Step Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Chapter 7
Catalogues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Catalogues Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Searching for Items in the Catalogues Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Catalogue Item Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Creating Shortcuts to Catalogue Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Catalogues - Analytical Models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Creating Analytical Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Analytical Model Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Context Dependency Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Dependency Rules Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
About Alternative Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Component Connections Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Component Signal Connections Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Code Stub Generation Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Selection from Catalogue Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Feature Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Creating Option Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Creating Curve or Equation Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Component Application Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Example: Creating a CAM Using Performance Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Example: Creating a CAM Using Performance Data - Deriving the Linear Coefficients for a
Loss. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Example: Creating a CAM Using Performance Data - Creating the CAM . . . . . . . . . . . 250
Example: Creating a CAM Using Performance Data - Generating the Code Stub . . . . . 252
Example: Creating a CAM Using Performance Data - Creating a new Project and adding the
Code Stub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Example: Creating a CAM Using Performance Data - Adding a Simcenter Flomaster
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Example: Creating a CAM using Performance Data - Editing the Code Stub. . . . . . . . . 255
Example: Creating a CAM Using Performance Data - Compiling the Code and Copying the
.dll. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Example: Creating a CAM Using Performance Data - Creating and Customizing a
Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Example: Creating a CAM Using Performance Data - Using the Component in a Network
264
Example: Creating a CAM Using Performance Data - Running a Simulation on the Test
Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Catalogues - Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

October 2020
Table of Contents
Creating a New Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Copying Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Customizing Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Component Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Creating a New Component Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Adding Allowed Analytical Models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Adding Allowed Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Adding Output Results Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Showing a Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Composite Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Creating a Composite Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Adding a Symbol to a Composite Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Deducing the Arms and Internal Circuits for a Composite Component . . . . . . . . . . . . . 281
Adding Signals to the Composite Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Defining the Data Model for Composite Components. . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Working with Composite Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Viewing Extended Properties for Components or Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Copy Features to Other Components and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Copying Features Across Sub-forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Using the Multiple Edit Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Catalogues - Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Create a New Material Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Create a New Material Based on a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Setting the Materials Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Copying Materials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Materials Based On External Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Materials Based On The Eagle Fluids Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
GASPAK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
NIST REFPROP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Creating a New Fluid based on CAPE-OPEN Properties . . . . . . . . . . . . . . . . . . . . . . . . 323
Catalogues - Performance Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Copying Performance Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Displaying Performance Data as Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Creating New Curves and Surfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Creating a Curve or Surface Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Adding Performance Data to a Curve Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Adding Performance Data to a Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Table Value Scaling Function Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Chebyshev Coefficients Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Chebyshev Coefficient Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Creating Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Equation Cutoff Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Creating Pump Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Choosing the Correct Form of Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Creating Pump Head Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Inputting Pump Curves - Worked Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Creating Pump Torque Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Creating New Loss Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

October 2020
Table of Contents
Creating a Loss Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

Adding Performance Data To A Loss Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Creating New Nusselt Surfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Creating a Nusselt Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Flow Coefficient Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Creating Flow Coefficient Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Catalogues - Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Creating Scripts - General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Creating Scripts - Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Example 1: Creating a VB.Net Slider Bar Initialization Script . . . . . . . . . . . . . . . . . . . . 371
Example 2: Creating a C# Slider Bar Initialization Script . . . . . . . . . . . . . . . . . . . . . . . . 372
Example 3: Creating a VB.Net Controller Script. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Example 4: Creating a C# Controller Script. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Catalogues - Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Creating and Executing Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Catalogues - Sub-systems and Sub-circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Creating Sub-Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Catalogues - Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Creating New Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Attaching Symbols to Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Changing the Appearance of Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Chapter 8
Using M.O. Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Chapter 9
Printing and Customizing Plots and Network Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Print Previewing Plots and Network Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Changing the Line and Marker Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Changing The Axis Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Customizing the General Features for Surfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Customizing the Display Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Menu Customization Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Changing The Colors of Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Customizing the Color of Surfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Exporting Graph and Plot Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Printing Plots and Surface Graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Using the Zoom Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Chapter 10
Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Errors and Warnings - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Viewing Errors, Warnings, and Convergence Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Generating Input Audit Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Generating Component Results Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Generating Network Data Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Generating Simulation Results Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Input Data Browser and Plug-in Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

October 2020
Table of Contents
Generating an Input Data Browser Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Exporting an Input Data Browser or Plug-in Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Print Preview an Input Data Browser or Plug-in Report . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Saving an Input Data Browser or Plug-in Report as a Template . . . . . . . . . . . . . . . . . . . . 410
Executing, Deleting or Renaming Input Data Browser and Plug-in Report Templates . . . 411
Generating a Result Based Plug-in Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Accessing an Input Data Browser Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Chapter 11
Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
The Network Views Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Collecting and Filtering Component and Node Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Drawing Component and Node Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Viewing Component Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Viewing Node Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Validating Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Accessing Results from the Project View Pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Attaching Items to Results Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Deleting Result Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Protecting Result Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Plotting Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
The Results Plot Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Attaching Plots to Results Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Integrating Plots - Worked Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
Integrating Plots Example - Building the Network and Entering the Data . . . . . . . . . . . 436
Integrating Plots Example - Running a Simulation on the Test Network . . . . . . . . . . . . 438
Integrating Plots Example - Performing the Integration . . . . . . . . . . . . . . . . . . . . . . . . . 439
Frequency Domain Processing and Fourier Transform Plots . . . . . . . . . . . . . . . . . . . . . . . 440
Fourier Transformation Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
Fourier Transform Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Converting the plot into an Amplitude v Frequency plot. . . . . . . . . . . . . . . . . . . . . . . . . 443
Converting the plot into a Power Spectrum plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Dashboards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Dashboards - Creating a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Dashboards - Creating Plots of Component Values Versus Time . . . . . . . . . . . . . . . . . . . 445
Dashboards - Creating Plots of One Component Value Versus Another . . . . . . . . . . . . . . 446
Dashboards - Working with Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Air Conditioning Results - Plotting a P-h Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Plot a Selected Feature Against Another Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Viewing Results Dynamically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Network Results Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Creating and Using Network Result Sensors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Chapter 12
Pack and Unpack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Packing Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Unpacking a Pack File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

October 2020
Table of Contents
Chapter 13
AVL EXCITE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
AVL EXCITE Bearing Component - Importing Data Files into Simcenter Flomaster. . . . . 459
AVL EXCITE Bearing Component - Using Data Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Chapter 14
Variable Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Variable Parameters - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Creating Input Variable Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Creating Output Variable Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Chapter 15
Experiments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
Creating an Experiment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Deleting an Experiment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Parametric Studies Experiments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Setting Up Parametric Studies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Sequential Blocks Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Constant and Sequential Blocks Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Constant and Sequential Blocks with Repeats Example . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Latin Square Experiments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Defining General Input Data for Latin Square Experiments . . . . . . . . . . . . . . . . . . . . . . . 475
Monte Carlo Experiments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Generating Input Data Monte Carlo Experiments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Reviewing Results of Experiments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Viewing the Results of an Experiment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Displaying Input and Output Parameter Details From the Results Tables . . . . . . . . . . . . . 480
Create Ad Hoc plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Creating Ad Hoc Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Creating Output Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Exporting the results of an Experiment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Response Surfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Creating a Response Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Change the Response Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Viewing the Deviation Details for a Response Surface . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Meta-Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Working with Meta-Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Entering Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Exporting XML Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Fetching a Value From an External Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Chapter 16
Cavities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Cavity Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Cavity Modelling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Creating a New Cavity Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Drawing the Cavity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
The Cavity Configuration Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

October 2020
Table of Contents
Using the Cavity Configuration Wizard - Dividing the Cavity . . . . . . . . . . . . . . . . . . . . . 502

Rearranging the External Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
Specifying Face Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Configuring the Cavity Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
Adjusting the Node Elevations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Viewing the Cavity Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Viewing the Individual Cell and Face Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Using the Cavity Results Viewer Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Chapter 17
Modeling Air Conditioning Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Chapter 18
Air Conditioning Shape Factor Optimization Program (ACSOP) . . . . . . . . . . . . . . . . . . 527
Using ACSOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
ACSOP - Worked Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
The ACSOP Optimization Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Using the Boundary Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Chapter 19
Visualiser and Segmenter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
The Visualiser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
The Visualiser Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
Setting the Visualiser Component Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Updating Data From the Visualiser Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
The Segmenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
The Segmenter - An Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
The Segmenter - Defining Split Planes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
The Segmenter - Running a Segmentation Simulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
The Segmenter - Viewing Segmentation Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
The Segmenter - Defining the Coordinate System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
Chapter 20
Modeling Vehicle Systems in 3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Modeling Body Forces in 3D Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
The 3D Coordinate System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Modeling the Vehicle Position using Aircraft Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Modeling Pitch, Roll, and Yaw, Dynamically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Chapter 21
Flashing and Two Phase Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Flashing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Two Phase Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Chapter 22
Component Interaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
Component Interaction Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
Component Interaction Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590

October 2020
Table of Contents
Running a Component Interaction Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Chapter 23
Drive Cycles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Chapter 24
Flow Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Flow Balancing - Which Components Can I Use? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Chapter 25
Ambient Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Ambient Conditions - Parameter Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Ambient Conditions - Simulation Descriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
Chapter 26
Zero Flow Heat Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Zero Flow Heat Transfer - Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Modeling Zero Flow Heat Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Zero Flow Heat Transfer - Thermally Neutral Components . . . . . . . . . . . . . . . . . . . . . . . . 619
Chapter 27
1D Heat Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Modeling 1D Heat Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Applying a Temperature Profile to a 1D Heat Transfer Network . . . . . . . . . . . . . . . . . . . . . 627
Applying a Heating Profile to a 1D Heat Transfer Network . . . . . . . . . . . . . . . . . . . . . . . . . 628
Chapter 28
Geographic Information Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Importing GIS Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
Selecting the GIS Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
GIS Pipeline Import - Reviewing and Modifying the Imported Metadata . . . . . . . . . . . . . 633
Setting the Simcenter Flomaster Pipe Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
Importing Data from the Metadata File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
Viewing the Pipe Runs, Elevations and Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
Creating the Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
Chapter 29
Electronic Data Interchange Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Creating and Editing EDIF Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Chapter 30
Simcenter Flomaster Direct Network Assembly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
FMDNA Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
FMDNA Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Saving the File and Executing the FMDNA Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
Adding Controllers and Gauges to a Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
Adding Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656

October 2020
Table of Contents
Adding Signal Links for a Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657

Adding Gauges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Adding Signal Links for a Gauge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Using FMDNA to Create a Cavity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Creating Cavities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Adding Extensions to the FMDNA File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Defining Connections Between Components and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Defining the Eye Point Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Defining Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Defining Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
Accessing FMDNA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
Chapter 31
FMU Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
Setting Up For FMU Exports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
Chapter 32
Hydrodynamic Force Results Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Exporting Hydrodynamic Force Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Chapter 33
N-Arm Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
N-Arm Component - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
Creating a Scriptable N-Arm Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
Creating an N-Arm Component using .floarm FloEFD Data . . . . . . . . . . . . . . . . . . . . . . . . 704
Creating an N-Arm Component Using OneSim FloEFD Data . . . . . . . . . . . . . . . . . . . . . . . 705
N-Arm Components: Restrictions and Conditions of Use of OneSim Components . . . . . . . 707
The N-Arm Component - GPL Tuning Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Chapter 34
3D CAD Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
3D CAD Piping Import Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
3D CAD Import Tool Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
3D CAD Tool Mapping Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
Importing a 3D CAD File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Creating Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
Editing and Deleting Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
CAD to Simcenter Flomaster Sub-System Import Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
Importing cad2fm Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
Chapter 35
MotorSolve File Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
Creating a Simcenter Flomaster Component from a MotorSolve file . . . . . . . . . . . . . . . . . . 727
Chapter 36
Pipe Schedule Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Using the Pipe Schedule Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729

October 2020
Table of Contents
Importing a New Pipe Schedule Standard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731

Managing Pipe Schedule Standards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Chapter 37
Vapor Cycle Components and Waste Heat Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
The Vapor Cycle Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
Using The VC Circuit Manager Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Plotting The Results Of Waste Heat Recovery Simulations . . . . . . . . . . . . . . . . . . . . . . . . . 741
Using Multiple Speed Controlled Components in Waste Heat Recovery Simulations . . . . . 742
Using VC Turbine Components in Waste Heat Recovery Simulations . . . . . . . . . . . . . . . . 744
Using VCSOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Chapter 38
User Group Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
User Group Management Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Creating User Logons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Deleting User Logons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Viewing Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Adding and Removing Users From a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Creating User Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Deleting User Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Permission Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Viewing Permission Set Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Creating Permission Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Deleting Permissions Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
Catalogue Access Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
User Access Control - Legacy Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Creating User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Copying User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Deleting User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Viewing Roles for Catalogue Access Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Creating Catalogue Access Permission Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Deleting Catalogue Access Permission Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Creating New Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Deleting Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
Parent Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Parent Role Example Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Setting Permissions Without Using the Parent Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Setting Permissions Using the Parent Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Setting the Parent Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Removing the Parent Role From a Child Role. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Assigning Multiple Administrator Accounts in Active Directory . . . . . . . . . . . . . . . . . . . 773
Using GUI Automation Login Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Chapter 39
Configuring Simcenter Flomaster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Schematic Configuration Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780

October 2020
Table of Contents
Maintaining Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788

Specifying the Unit Set for a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Applying a Unit Set for an Individual Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Managing Unit Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Editing Unit Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
Maintaining Symbol Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
Maintaining Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Chapter 40
Database Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Searching the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Opening the Database Search Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Using the Database Search Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
Using the Database Search Tool - General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
Using the Database Search Tool - Data Item Specific Search Terms . . . . . . . . . . . . . . . 804
Shrinking a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
Using SQL Server Management Studio to Shrink the Database . . . . . . . . . . . . . . . . . . . . 806
Shrinking the Database Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807
Restoring a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Database Recovery Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Setting the Directory Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
Using the Database Reporting Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Hybrid Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
Storing Hybrid Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
Checking Result Sets In and Out of the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Chapter 41
FlowmasterLink for MATLAB Simulink. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
FlowmasterLink for Simulink - The Co-simulation Process . . . . . . . . . . . . . . . . . . . . . . . . . 818
FlowmasterLink for Simulink - Setting Up The Connections . . . . . . . . . . . . . . . . . . . . . . . . 819
FlowmasterLink for Simulink - Defining the Simcenter Flomaster Network . . . . . . . . . . . . 821
FlowmasterLink for Simulink - Specifying the Simcenter Flomaster Simulation Data . . . . 823
FlowmasterLink for Simulink - Setting Up and Running Co-simulations . . . . . . . . . . . . . . 826
FlowmasterLink for Simulink - Running a Co-simulation . . . . . . . . . . . . . . . . . . . . . . . . . 827
FlowmasterLink for Simulink - Common Errors and Issues . . . . . . . . . . . . . . . . . . . . . . . 827
FlowmasterLink for Simulink - Example 1: A Simple Co-simulation . . . . . . . . . . . . . . . . 830
FlowmasterLink for Simulink - Example 2: Co-simulation Using Macros . . . . . . . . . . . . 832
FlowmasterLink for Simulink - Example 3: Reading Co-simulation Concentration Results
836
Chapter 42
Co-simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
Adding Co-simulation Boundary Components to your Network . . . . . . . . . . . . . . . . . . . . . 839
Creating a Simcenter Flomaster FMU Export File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
Creating an FMU for Model Exchange Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840

October 2020
Table of Contents
Chapter 43
Automation in Simcenter Flomaster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
GUI Automation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Analysis Automation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Automation - Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
How COM is Implemented . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
Chapter 44
Command Line Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847
Executing Command Line Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
Processing the Batch File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
Creating Batch Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
Using the 'CreateProject' Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Executing the 'CreateProject' Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Using Command Line Utilities to Create a New Network . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Deleting a Network using the Command Line Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Executing the 'DeleteNetwork' Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Unpacking a Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Executing the 'UnpackNetwork' Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
Appendix A
Performance Data Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867
GetYfromX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
GetY_dydxFromX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
GetY_dYdXfromIntlExtrapolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 870
GetXfromY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
EvaluateIntegral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
GetXLimits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
IsCurveSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
GetZfromXY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
GetZandGradfromXandY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
GetXorYfromSurfaceUsingBisection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
GetYLimits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
IsSurfaceSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Third-Party Information

October 2020
List of Figures
Figure 3-1. The Project Properties Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Figure 4-1. The Rendering Configuration Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Figure 4-2. The Move Text Options Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Figure 5-1. Nodes - A Simple Rising Main . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Figure 5-2. Internal Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Figure 5-3. The Component Connection Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Figure 5-4. The Layer Manager Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Figure 5-5. Using the Layer Manager - Example Network . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Figure 6-1. Running a Simulation - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Figure 6-2. The Data Sub Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Figure 6-3. The Data Sub Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Figure 6-4. The Output Control Sub-Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Figure 6-5. The Pipe Profile Data Sub Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Figure 6-6. Simulation Failure Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Figure 6-7. The Node Data Form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Figure 6-8. The Aircraft Data Sub Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Figure 6-9. The Aircraft Data Sub Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Figure 6-10. The Y Coordinate Node Data Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Figure 6-11. The Ambient Conditions Data Sub Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Figure 6-12. Swirl Effects - Combined View of Top-level Network and Cavity Network. . 166
Figure 6-13. Velocity Vectors - Vector Addition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Figure 6-14. Velocity - Stationary or rotating Disks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Figure 6-15. Velocity Vectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Figure 6-16. Impingement Loss Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Figure 6-17. Creating a Random Time Restart File - The Restart Data Sub Form . . . . . . . . 185
Figure 6-18. Creating a Sequential Time Restart File - The Restart Data Sub Form . . . . . . 186
Figure 6-19. Example Serialized Restart File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Figure 6-20. Restart Selection Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Figure 6-21. Geometric Heat Exchange Wizard - Generic Tube Arrangement Example . . . 190
Figure 6-22. Geometric Heat Exchange Wizard - Fin and Tube Example . . . . . . . . . . . . . . 191
Figure 6-23. Fin and Tube Example - Showing Implicit Nodes . . . . . . . . . . . . . . . . . . . . . . 192
Figure 6-24. Geometric Heat Exchanger Wizard - Example Script . . . . . . . . . . . . . . . . . . . 193
Figure 6-25. Geometric Heat Exchanger Wizard - Example Network . . . . . . . . . . . . . . . . . 195
Figure 6-26. Geometric Heat Exchanger Wizard - Virtual network Corresponding to
Connectivity Example 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Figure 6-29. Geometric Heat Exchange Wizard - Starting Point . . . . . . . . . . . . . . . . . . . . . 199

October 2020
List of Figures
Figure 6-30. Geometric Heat Exchange Wizard - Generic Example. . . . . . . . . . . . . . . . . . . 201

Figure 6-31. Geometric Heat Exchange Wizard - Generic Example Script . . . . . . . . . . . . . 201
Figure 6-32. Example with Missing Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Figure 6-33. Geometric Heat Exchange Wizard - Tube Arrangements. . . . . . . . . . . . . . . . . 205
Figure 6-34. Geometric Heat Exchange Wizard - Fin and Tube Example . . . . . . . . . . . . . . 206
Figure 6-35. Geometric Heat Exchange Wizard - Numbered Tube Bundles, Implicit Nodes and
Air Flows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Figure 6-36. Geometric Heat Exchange Wizard - Serpentine Heat Exchanger Script . . . . . 211
Figure 6-37. Hydraulic Gradient Line Example Network . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Figure 7-1. CAM Example—Component Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Figure 7-2. Completed CAM Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Figure 7-3. CAM Example—Compiling the Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Figure 7-4. Creating a CAM Using Performance Data - Example Network . . . . . . . . . . . . . 265
Figure 7-5. Example Simulation Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Figure 7-6. Component Customisation Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Figure 7-7. Feature Selection Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Figure 7-8. Integer Feature Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Figure 7-9. Real Feature Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Figure 7-10. Composite Components - Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Figure 7-11. Building a Composite Component - The Network View Tabs . . . . . . . . . . . . . 280
Figure 7-12. The Composite Component Connections Form . . . . . . . . . . . . . . . . . . . . . . . . 282
Figure 7-13. Composite Components - Arm Mapping Dialog Box . . . . . . . . . . . . . . . . . . . 282
Figure 7-14. Composide Components - Arm Mapping Examples . . . . . . . . . . . . . . . . . . . . 284
Figure 7-15. Composite Component - Signal Mappings Dialog Box . . . . . . . . . . . . . . . . . . 285
Figure 7-16. Select Measurement Option Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Figure 7-17. Composite Components - Example of Signal Mapping . . . . . . . . . . . . . . . . . . 286
Figure 7-18. Composite Component - Graphical Port Placement . . . . . . . . . . . . . . . . . . . . . 287
Figure 7-19. The Data Model Form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Figure 7-20. The Extended Properties Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Figure 7-21. Example Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Figure 7-22. The Properties Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Figure 7-23. Creating a New Material Template - The Fluid Sub Form Dialog Box . . . . . . 297
Figure 7-24. Creating a New Material based on a Template - The Material Property Dialog Box
301
Figure 7-25. Creating a GASPAK material - The Component Customisation Form - Example
307
Figure 7-26. Creating a New NIST REFPROP Material - Calculation Model Preferences Dialog
Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Figure 7-27. Creating a New NIST REFPROP Material - Pure Fluid (Single Compounds) Dialog
Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Figure 7-28. Creating a New NIST REFPROP Material - Pressure and Temperature Conditions
Dialog Box - Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Figure 7-29. Creating a New NIST REFPROP Material - Fluid Property Data Generation Report
Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Figure 7-30. Displaying Performance Data as Plots - The 2D Performance Plot Window. . 330

October 2020
List of Figures
Figure 7-31. Displaying Performance Data as Plots - The 3D Performance Plot Window. . 331
Figure 7-32. The Table Value Scaling Function Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . 337
Figure 7-33. Chebyshev Polynomial Coefficient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Figure 7-34. The X and Y Cut Off Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Figure 7-35. Creating Scripts - Script and Plug-In Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Figure 7-36. Example 1: Creating a VB.Net Slider Bar Initialization Script . . . . . . . . . . . . 372
Figure 7-37. Example 2: Creating a C# Slider Bar Initialization Script . . . . . . . . . . . . . . . . 373
Figure 7-38. Creating Macros - Script and Plug-In Editor . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Figure 7-39. Creating a New Symbol - The Select Symbol Dialog Box. . . . . . . . . . . . . . . . 380
Figure 7-40. The Maintain Symbol Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Figure 9-1. Changing the Line and Marker Properties - Chart Properties Dialog Box . . . . . 387
Figure 9-2. Chart Properties Dialog Box - Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Figure 9-3. Customize Surface Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Figure 9-4. The Actual Data Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Figure 9-5. Exporting Graph and Plot Images - The Image Export Dialog Box . . . . . . . . . . 395
Figure 10-1. The Network Data Report Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Figure 10-2. The Analysis Result Report Generation Options . . . . . . . . . . . . . . . . . . . . . . . 404
Figure 10-3. The Remove Column Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Figure 10-4. Pipe Profile Data Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Figure 10-5. Executing, Deleting or Renaming Input Data Browser and Plug-in Report
Templates - The Reporting Templates Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Figure 10-6. Generating a Result Based Plug-in Report - Displaying Plot Results . . . . . . . 413
Figure 10-7. Generating a Result Based Plug-in Report - The Cavitation Plot. . . . . . . . . . . 413
Figure 10-8. Generating a Result Based Plug-in Report - Pipe End Location Warnings . . . 414
Figure 10-9. Generating a Result Based Plug-in Report - Node Level Warnings. . . . . . . . . 415
Figure 10-10. Accessing an Input Data Browser Report - Example 1. . . . . . . . . . . . . . . . . . 416
Figure 11-1. Collecting and Filtering Component and Node Results - The Component Results
Filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Figure 11-2. The Draw Attribute Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Figure 11-3. Drawing Component Results - Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Figure 11-4. Accessing Results from the Project View Pane . . . . . . . . . . . . . . . . . . . . . . . . 429
Figure 11-5. Attaching an Item to a Results Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Figure 11-6. Signed Off Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Figure 11-7. Integrated Plots - Example Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
Figure 11-8. Combined Integration Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Figure 11-9. The Integration Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Figure 11-10. P-h Diagram Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
Figure 12-1. Duplicate Item Decision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Figure 15-1. Parametric Studies - Defining Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Figure 15-2. Example (a) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Figure 15-3. Example (b). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Figure 15-4. Example (c) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Figure 15-5. The Expression Builder Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Figure 15-6. The XML Source Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Figure 15-7. The Table Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492

October 2020
List of Figures
Figure 15-8. The XML Source Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492

Figure 16-1. Cavity Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Figure 16-2. How a Cavity is Divided into Cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
Figure 16-3. Four-arm Cavity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
Figure 16-4. The Rearrange External Connections Form . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Figure 16-5. The Specify Default Face Types Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
Figure 17-1. Typical AC Circuit with Additional Simcenter Flomaster Components . . . . . 525
Figure 18-1. ACSOP: Internal Heat Exchanger Shape Factor Tool . . . . . . . . . . . . . . . . . . . 529
Figure 18-2. ACSOP: Condenser Test Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Figure 18-3. ACSOP: Condenser Shape Factor Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Figure 18-4. ACSOP: The Inside and Outside Shape Factors . . . . . . . . . . . . . . . . . . . . . . . . 535
Figure 18-5. ACSOP: The Inside and Outside Shape Factors . . . . . . . . . . . . . . . . . . . . . . . . 535
Figure 18-6. ACSOP: The Resulting Property Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Figure 19-1. Using the Visualiser - Example Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
Figure 19-2. Using the Visualiser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Figure 19-3. Setting the Visualisation Component Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Figure 19-4. The Component Boarders - The Visualiser Window . . . . . . . . . . . . . . . . . . . . 551
Figure 19-5. The Component Boarders 2- The Visualiser Window . . . . . . . . . . . . . . . . . . . 552
Figure 19-6. The Segementer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
Figure 19-7. The Segementer Model - A Diagramatical View of Test Network . . . . . . . . . 556
Figure 19-8. The Segementer Model - The Test Network. . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Figure 19-9. The Segementer Model - The Segmented Network . . . . . . . . . . . . . . . . . . . . . 557
Figure 19-10. The Segementer Model - Orientation of Heat Exchangers . . . . . . . . . . . . . . . 558
Figure 19-11. The Segementer Model - Segmenter Groups . . . . . . . . . . . . . . . . . . . . . . . . . 559
Figure 19-12. The Segementer Model - Define Split Panes . . . . . . . . . . . . . . . . . . . . . . . . . 561
Figure 19-13. The Segementer Model - Example 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
Figure 19-14. The Segementer Model - Example 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
Figure 19-15. The Segementer Model - The Components Dialog Box. . . . . . . . . . . . . . . . . 564
Figure 19-16. Viewing Segementation Results - Example Network. . . . . . . . . . . . . . . . . . . 566
Figure 19-17. Viewing Segementation Results - Results Plot. . . . . . . . . . . . . . . . . . . . . . . . 567
Figure 19-18. Viewing Segementation Results - The Colour / Range Band Selection Dialog Box
568
Figure 19-19. Viewing Segementation Results - The Visualiser Window . . . . . . . . . . . . . . 569
Figure 19-20. Defining the Coordinate System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
Figure 20-1. The 3D Coordinate System in Vehicle Simulations . . . . . . . . . . . . . . . . . . . . . 576
Figure 20-2. Defining the Centre of Rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
Figure 20-3. Movement about the Centre of Rotation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
Figure 22-1. Defining Combination Angles for Bends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
Figure 22-2. Defining Combination Angles for Junctions . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Figure 22-3. Defining Combination Angles for Pumps . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Figure 22-4. Running Component Interaction Simulations. . . . . . . . . . . . . . . . . . . . . . . . . . 596
Figure 24-1. Incorrect Usage of Flow Specifying Components . . . . . . . . . . . . . . . . . . . . . . 601
Figure 24-2. Flow Balancing - Example Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Figure 26-1. Zero Flow Heat Transfer Modelling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Figure 27-1. 1D Heat Transfer - Components Exchanging Heat. . . . . . . . . . . . . . . . . . . . . . 621

October 2020
List of Figures
Figure 27-2. Modeling 1D Heat Transfer - Example Network . . . . . . . . . . . . . . . . . . . . . . . 623

Figure 27-3. Modeling 1D Heat Transfer - Pipe Run Colors . . . . . . . . . . . . . . . . . . . . . . . . 625
Figure 27-4. Modeling 1D Heat Transfer - Temperature Results . . . . . . . . . . . . . . . . . . . . . 626
Figure 27-5. Modeling 1D Heat Transfer - Mass Flow Results . . . . . . . . . . . . . . . . . . . . . . 626
Figure 27-6. Applying a Temperature Profile to a 1D Heat Transfer Network - Example Network
627
Figure 27-7. Applying a Temperature Profile to a 1D Heat Transfer Network - Results . . . 628
Figure 28-1. Defining Segments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Figure 28-2. The Metadata Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
Figure 28-3. The Part Data Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Figure 28-4. The Part Data Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
Figure 28-5. The MetaData Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
Figure 28-6. MetaData Mappings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
Figure 28-7. The Contiguous Pipe Groups Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
Figure 30-1. Component Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Figure 30-2. Node Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Figure 30-3. Specifying the X, Y, Z Coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Figure 30-4. Link Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Figure 30-5. 3D Representative Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Figure 30-6. Deriving the X Coordinate for a Component . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Figure 30-7. Deriving the Y Coordinate for a Component . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Figure 30-8. Creating and Editing FMDNA Files - Example Network. . . . . . . . . . . . . . . . . 654
Figure 30-9. Adding a Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Figure 30-10. Adding a Controller - Example Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Figure 30-11. Adding Signal Links for a Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
Figure 30-12. Adding Controller Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Figure 30-13. Adding a Gauge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Figure 30-14. FMDNA - Adding a Gauge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Figure 30-15. Adding Signal Links for a Gauge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Figure 30-16. Creating a Cavity - Example Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Figure 30-17. Creating a Cavity - Defining Components - Example 1 . . . . . . . . . . . . . . . . . 667
Figure 30-22. Creating a Cavity - Defining Nodes - Example 1 . . . . . . . . . . . . . . . . . . . . . . 670
Figure 30-25. Creating a Cavity - Defining Connections - Example 1 . . . . . . . . . . . . . . . . . 671
Figure 30-31. Defining the Eye Point Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674

October 2020
List of Figures
Figure 30-32. FMDNA File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676

Figure 30-33. FMDNA Outline XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Figure 30-34. FMDNA Outline XML Sub-Element File . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Figure 30-35. FMDNA XML Code Cells Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Figure 30-36. FMDNA XML External Connections Example . . . . . . . . . . . . . . . . . . . . . . . 683
Figure 30-37. Adding Extensions to the FMDNA File - Example Network . . . . . . . . . . . . . 683
Figure 30-38. Defining Connections - Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Figure 30-44. Defining Nodes - Example 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Figure 30-47. dmComponent Collection Editor Dialog Box - Example 1 . . . . . . . . . . . . . . 691
Figure 33-1. The N-Arm Component Wizard Preview Pane. . . . . . . . . . . . . . . . . . . . . . . . . 706
Figure 34-1. Unmapped Component Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Figure 34-2. 3D CAD Import Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
Figure 34-3. Materials Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Figure 34-4. Importing cad2fm Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
Figure 35-1. The MotorSolve Import Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
Figure 36-1. Importing a New Pipe Schedule Standard - Tab Delimited Example. . . . . . . . 731
Figure 37-1. Using Multiple Speed Controlled Components in Waste Heat Recovery Simulations
- Mass Flow Versus Pressure Drop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
Figure 38-1. Individual User Permissions - Legacy Configurations Only . . . . . . . . . . . . . . 748
Figure 38-2. User Group Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
Figure 39-1. Schematic Configuration Dialog Box — General Options Tab . . . . . . . . . . . . 781
Figure 39-2. Schematic Configuration Dialog Box — Colour Control Tab . . . . . . . . . . . . . 782
Figure 39-3. Schematic Configuration Dialog Box — Pipe Configuration Tab . . . . . . . . . . 783
Figure 39-4. Schematic Configuration Dialog Box — Image Import Tab . . . . . . . . . . . . . . 784
Figure 39-5. Unit System Update Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Figure 39-6. Unit System Update Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Figure 39-7. The Maintain Symbol Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
Figure 40-1. Database Search Tool (Selection from Catalogue dialog) . . . . . . . . . . . . . . . . 802
Figure 40-2. The Database Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807
Figure 40-3. The Database Files Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
Figure 40-4. Shrink Files Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
Figure 40-5. The Database Files Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Figure 40-6. Database Recovery - The Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . 810
Figure 40-7. Database Recovery - The Status Bar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811

October 2020
List of Figures
Figure 40-8. Hybrid Results - The Results Set/Audit Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . 814

Figure 41-1. The Simcenter Block Parameters: Goto Dialog Box . . . . . . . . . . . . . . . . . . . . 820
Figure 41-2. The FM4SL Logon Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Figure 41-3. The FM4SL Data Setup dialog - Setting the Simulation Data . . . . . . . . . . . . . 823
Figure 41-4. Example 1: Co-simulation Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Figure 41-5. Example 1: Co-simulation Network: The Simulink Window. . . . . . . . . . . . . . 831
Figure 41-6. Example 1: Co-simulation Network: Results . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Figure 41-7. Example 2: Co-simulation Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
Figure 41-8. Example 2: Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
Figure 41-9. Example 2: Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Figure 41-10. Example 3: The Simcenter Flomaster Network . . . . . . . . . . . . . . . . . . . . . . . 837
Figure 41-11. Example 3: The Simulink Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
Figure 42-1. Co-simulation Boundaries Example Network . . . . . . . . . . . . . . . . . . . . . . . . . 839
Figure 44-1. The Command Interpreter Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
Figure 44-2. The Create Project Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Figure 44-3. The Create network Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Figure 44-4. The Delete Network Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Figure 44-5. The Unpacking Network Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862

October 2020
List of Figures

October 2020
List of Tables
Table 1-1. The Simcenter Flomaster Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Table 1-2. Input Field Cell Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Table 1-3. Logon Page Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Table 1-4. Database Configuration Page Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Table 1-5. Database Space Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Table 1-6. Configuration Utility Dialog Box - SQL Option . . . . . . . . . . . . . . . . . . . . . . . . . 39
Table 1-7. Configuration Utility Dialog Box - Oracle Option . . . . . . . . . . . . . . . . . . . . . . . 39
Table 2-1. Installation Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Table 3-1. Network and Data Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Table 4-1. The Network Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Table 4-2. The Network Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Table 4-3. Importing Background Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Table 5-1. Nodes - Levels in a Rising Main . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Table 5-2. Rotating Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Table 5-3. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Table 5-4. Layer Manager Dialog Box Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Table 5-5. Tasks To Perform in the Layer Manager Dialog Box . . . . . . . . . . . . . . . . . . . . . 128
Table 6-1. Ambient Conditions Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Table 6-2. The Convergence and Tolerance Criteria Form Options . . . . . . . . . . . . . . . . . . 141
Table 6-3. The Default Material Form Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Table 6-4. The Output Control Sub-Form Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Table 6-5. Setting the Fluid Properties Caching Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Table 6-6. The Pipe Profile Data Form Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Table 6-7. Setting the Aircraft Data Form Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Table 6-8. Run-Time Error Halt Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Table 6-9. Run-Time Warning Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Table 6-10. Setting the Turbine Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Table 6-11. Setting the Ambient Data Form Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Table 6-12. Creating a Sequential Time restart File Data Form Options . . . . . . . . . . . . . . . 186
Table 6-13. Geometric Heat Exchange Wizard - Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Table 6-14. Hydraulic Gradient Line Example - Component and Node Data . . . . . . . . . . . 213
Table 7-1. Catalogues Tab Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Table 7-2. Analytical Model Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Table 7-3. Dependency Rules Dialog Box Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Table 7-4. Required Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Table 7-5. Component Connections Dialog Box Contents . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Table 7-6. Component Signal Connections Dialog Box Contents . . . . . . . . . . . . . . . . . . . . 239
Table 7-7. Code Stub Generation Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Table 7-8. Selection from Catalogue Dialog Box Contents . . . . . . . . . . . . . . . . . . . . . . . . . 241
Table 7-9. Input and Output Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

October 2020
List of Tables
Table 7-10. Generating the Code Stub—Interface Settings . . . . . . . . . . . . . . . . . . . . . . . . . 253

Table 7-11. Creating a CAM Using Performance Data - Component 1: Required Data . . . 265
Table 7-14. Modifying Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Table 7-15. Modifying Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Table 7-16. Creating a New Material Template - Customizing a Material Template . . . . . 297
Table 7-17. Setting the Materials Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Table 7-18. GASPAK Fluids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Table 7-19. NIST REFPROP 9.0 Pure Fluids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Table 7-20. Creating a Curve or Surface - Entering and Amending the Curve Data . . . . . . 332
Table 7-21. Creating Equations - Entering and Amending the Equation Data . . . . . . . . . . . 341
Table 7-22. Inputting Pump Curves - a Worked Example: Input Data . . . . . . . . . . . . . . . . 347
Table 7-23. Creating a Pump Torque Curve - Entering and Amending the Pump Torque Curve
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Table 7-24. Creating a Loss Curve - Entering and Amending the Loss Curve Data . . . . . . 354
Table 7-25. Creating a Nusselt Surface - Entering and Amending the Nusselt Surface Data 360
Table 7-26. Flow Coefficient Curve Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Table 7-27. Creating Equations - Entering and Amending the Equation Data . . . . . . . . . . . 366
Table 9-1. Print Preview Options for Plots and Network Diagrams . . . . . . . . . . . . . . . . . . 385
Table 9-2. Changing the Line and Marker Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Table 9-3. Changing the Axis Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Table 9-4. Video Topics Relating to Viewing and Editing Surfaces . . . . . . . . . . . . . . . . . . 390
Table 9-5. Customizing the General Features for Surfaces Sets . . . . . . . . . . . . . . . . . . . . . 391
Table 9-6. Customizing the Display Points Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Table 9-7. Using the Menu Customization Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Table 9-8. Customizing the Data Point Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Table 10-1. Generating Network Data Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Table 10-2. Generating Simulation Results Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Table 10-3. Viewing the Report Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Table 10-4. Viewing the Report Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Table 11-1. Collecting and Filtering Component and Node Results . . . . . . . . . . . . . . . . . . 420
Table 11-2. The Draw Attribute Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Table 11-3. Viewing Steady State Component Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Table 11-4. Viewing Node Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Table 11-5. document Types and Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
Table 11-6. Component 1: Required Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Table 11-10. Component 2: Required Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Table 11-11. Running a Simulation on the Test Network . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Table 11-12. Modifying Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
Table 15-1. Video Topics Relating to the Experiments Functionality . . . . . . . . . . . . . . . . . 465
Table 15-2. Example (a) - Constant Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

October 2020
List of Tables
Table 15-3. Example (b) - Constant Blocks (Repeating) . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

Table 15-4. Example (b) - Constant Blocks (Repeating) . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Table 15-5. Sequential Block - Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Table 15-6. Sequential Block - Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Table 15-7. Constant and Sequential Block - Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Table 15-8. Constant and Sequential Block Pattern- Example . . . . . . . . . . . . . . . . . . . . . . . 473
Table 15-9. Constant and Sequential Block - Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Table 15-10. Constant and Sequential Block Pattern- Example . . . . . . . . . . . . . . . . . . . . . . 474
Table 15-11. Viewing the Results of Experiments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Table 15-12. Changing the Response Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Table 15-13. The Deviation Details Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
Table 15-14. fetching a Value from an External Database . . . . . . . . . . . . . . . . . . . . . . . . . . 493
Table 16-1. Configuring a New Cavity Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Table 18-6. AC Boundary Input Data Combinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Table 19-1. Visualiser Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Table 19-2. Additional Component Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Table 19-3. The Segmentable Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
Table 19-4. 2D Array Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
Table 19-5. Viewing Segmentation Results - Colour Segments for Worked Example . . . . 569
Table 20-1. Aircraft Data - Specifying Flight Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Table 21-1. Components that can be used to Model Flashing . . . . . . . . . . . . . . . . . . . . . . . 583
Table 21-2. Two Phase Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Table 22-1. Component Interaction - Interactive Components . . . . . . . . . . . . . . . . . . . . . . 588
Table 22-2. Component Interaction - Non-Interactive Components . . . . . . . . . . . . . . . . . . 588
Table 22-3. Component Interaction Simulations - Flow Conventions . . . . . . . . . . . . . . . . . 597
Table 23-1. Drive Cycle Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Table 23-2. Simcenter Flomaster Drive Cycles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Table 24-1. Flow Balancing - Available Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Table 24-2. Flow Balancing Components - Additional Results and Features . . . . . . . . . . . 606
Table 25-1. Context Dependency Rules for Ambient Temperature . . . . . . . . . . . . . . . . . . . 609
Table 25-2. Context Dependency Rules for Atmospheric Pressure . . . . . . . . . . . . . . . . . . . 610
Table 26-1. ZFHT Component Data Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Table 26-2. ZFHT Simulation Data Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Table 28-1. GIS Import Tool Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Table 30-1. Link Settings and Appearance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Table 30-2. Adding Signal Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
Table 30-3. Adding Controller Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Table 30-4. Adding Signal Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Table 30-5. Defining Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Table 30-6. Login Details and Network Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694

October 2020
List of Tables
Table 37-1. Non-vapor Cycle Components Suitable for Waste Heat Recovery Applications 737
Table 37-2. Components Not Suitable for Waste Heat Recovery Applications . . . . . . . . . . 738
Table 38-1. User Group Management Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
Table 38-2. Simcenter Flomaster Supplied Permission Sets . . . . . . . . . . . . . . . . . . . . . . . . 755
Table 38-3. Creating Permission Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Table 39-1. Schematic Configuration Dialog Box — General Options Contents . . . . . . . . 784
Table 39-2. Schematic Configuration Dialog Box — Colour Control Contents . . . . . . . . . 785
Table 39-3. Schematic Configuration Dialog Box — Pipe Configuration Contents . . . . . . 786
Table 39-4. Schematic Configuration Dialog Box — Image Import Contents . . . . . . . . . . 787
Table 39-5. Unit Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Table 39-6. Maintaining Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Table 40-1. Video Topics Relating to the Searching the Database . . . . . . . . . . . . . . . . . . . 800
Table 41-1. Example of Controller Input Parameters for Simulink – Simcenter Flomaster Co-
simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Table 41-2. Example of Gauge Input Parameters for Simulink – Simcenter Flomaster Co-
simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Table 44-1. Command Line Arguments and Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
Table 44-2. Creating a Batch File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
Table 44-3. Creating a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Table 44-4. Creating a New Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Table 44-5. Deleting a New Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Table 44-6. Unpacking a New Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862

October 2020
Chapter 1
Introduction
To use Simcenter Flomaster™ software you must have a user name and password and specify
the locations and names of the database files that Simcenter Flomaster uses to store data.
Starting Simcenter Flomaster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Application Window Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Window Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Logon Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Database Space Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Starting Simcenter Flomaster

Simcenter Flomaster runs as a stand-alone application which you log into.
Procedure
1. Click Start on the Windows Task Bar.
2. Click All Programs > Simcenter Flomaster.
Simcenter Flomaster opens at the Launchpad.
From the Launchpad you can:
• Open recently used networks
• Create N-Arm components, new materials, and new performance data items such as
surfaces
• View sample systems (example Networks)
• Logon to Simcenter Flomaster
• View details about the Database and License
3. Click the button.

October 2020
Note - Viewing PDF files within a web browser causes some links not to function. Use HTML for full navigation.
Introduction
Starting Simcenter Flomaster
Results
Simcenter Flomaster starts.
Note
You can return to the Launchpad at any time by clicking the button at the top, left-hand side
of the Simcenter Flomaster menu bar.

October 2020
Introduction
Application Window Basics
Application Window Basics

This section gives an overview of parts of the Simcenter Flomaster interface and explains the
processes for saving your work.
Window Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Window Layout
The application window has three main panes with a menu and toolbar area at the top and a
status bar at the bottom:
Note
You can specify which Toolbars are visible from the View > Toolbars menu.

October 2020
Introduction
Tables
Table 1-1. The Simcenter Flomaster Panes

Region Details
Left-hand side The Project View pane contains a tabbed area, which you can use to
select networks, catalogues, and roles. When you select items in these
tabs, details of the selected item are shown in the bottom part of the
pane.
There is also a tab that you can use to share your work with other users.
Note: You can hide the Project View by unchecking the
Project View Option in the View menu.
Center The Network Drawing Window is where you create and edit
networks. You can open multiple networks at the same time; each is
displayed on a tab within the Network Drawing Window.
Right-hand side The Network View pane contains a tabbed area, which you use to:
• Set the parameters of the components and the simulation
• Define parameters for experiments
• Run simulations
• Review results
Related Topics
Tables
Status Bar
Tables
Project and Network View panes often display tables that show results or provide a method of
inputting data. The presence of a table is usually dependent upon the selection of other elements
in. For example, when a component is selected in the Network Drawing window, its input
parameters or results are displayed in a table in the Network View pane.
For Input field tables the cells are color coded.
Table 1-2. Input Field Cell Colors
Background Description Example
Color
Property Fields
White A user (or suitable default) value has been
provided.
Pale Yellow An optional field with the current value
“Not Set”. When set, this field changes to
a white background.

October 2020
Introduction
Status Bar
Table 1-2. Input Field Cell Colors (cont.)

Background Description Example
Color
Pink A mandatory field. You must enter a
value for these fields or the simulation
will fail. (An Error will be generated.)
Value Fields
Light Blue These fields contain a single button. Click
it to display either:
• a dialog box which you can use to
enter details
• a sub-form where you can select
options
Note: You exit sub-forms by clicking
the Return button.
Light Mauve These fields contain two buttons:
• to select an item. Clicking this
button opens a dialog box where you
can select items.
• to display the selected item.
Related Topics
Window Layout
Status Bar
Status Bar
The Simcenter Flomaster status bar (at the bottom of the Simcenter Flomaster application
window) displays details about the current network, the user logon, and the name, size limit, and
current free space available of the database.
Note
You can set a limit for the size of the database. When the limit is reached the Size Limit and
Free Space fields in the status bar will turn red. For more information on database settings
see Database Functions.
Related Topics
Window Layout
Tables

October 2020
Introduction
Configuration
Configuration
Simcenter Flomaster contains tools that you can use when setting up access (including
specifying a license) and specifying database details.
Logon Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Database Space Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

October 2020
Introduction
Logon Configuration
Logon Configuration
To access: Select Logon from the Launchpad.
Use this screen to specify the database and project, and the User Name and Password.
Objects
Table 1-3. Logon Page Contents
Field Description
Data Source Use the dropdown list to choose a data source (database name)
to use for the session.
Project Enter the name of the project to use for the session.
Windows Authentication When checked this specifies that the current windows user
name and password combination are used.
In this instance the user name field will be populated with the
Windows user name.
User Name and Password User Name and Password combination to log on.
Role You can specify a user role for the session.
When left blank you will be logged on at the highest role
applicable to your user account privileges.
For more information see Roles.
Remember Password When checked the User Name/Password combination is
retained for the next log in.
Usage Notes
You may need to contact your System Administrator for details of the log on type, user name/
password combination, project, and database that you need.
Related Topics
Database Configuration
Database Space Utility
Configuration Utility Dialog Box
Logon and Startup Dialog Box

October 2020
Introduction
To access: Select Database from the Launchpad.
Use this screen to specify the Simcenter Flomaster database type, server, and authentication
details.
Objects
Table 1-4. Database Configuration Page Contents
Field Description
DATABASE CONNECTION
Database Server Type Use the dropdown list to specify either:
• SQL Server Database
When this option is selected you must provide a sever name
in the Server field.
• Oracle Database
When this option is selected you must provide a Port
Number and Host Name in the applicable fields.
Note: Simcenter Flomaster supports the use of Microsoft Azure SQL Databases
Server Enter the name of the server.
Server Authentication 1. Click the > button and then use the dropdown list to specify
either:
• Windows Authentication
Note that this option is not available for Microsoft Azure
SQL databases.
• Server Authentication
With either option you can specify a User Name and
password, and check the Remember Password option to
save these details on subsequent log-ins.
2. Click SELECT to save your choices.
Database Use the dropdown list to choose a database.
User Name and Password User Name and Password combination to log on to
Simcenter Flomaster.
Note: For SQL Server Databases you can attach database files and configure SQL user
accounts and for Oracle databases you can specify host, service and port details from the
CONFIGURATION UTILITY dialog box (see Configuration Utility Dialog Box).

October 2020
Introduction
Table 1-4. Database Configuration Page Contents (cont.)

Field Description
ACTIVE CONNECTION This section shows details of the current, connected database:
You can review database usage in detail by clicking the SPACE
REPORT button to open the Database Space Utility.
For more information on the Database Space Utility see
Database Space Utility.
Remember Password When checked the User Name/Password combination is
retained for the next log in.
Usage Notes
You may need to contact your System Administrator for details of the log on type, user name/
password combination, project, and database that you need.
To use an Azure database you must have previously created an Azure account with Microsoft
and set up a database.
If you make any changes to any of the database settings, or open the Configuration Utility
dialog box, you must click the UPDATE AND RESTART button to apply the changes.
Related Topics
Logon Configuration

October 2020
Introduction

To access: Click the SPACE REPORT button on the Database section of Launchpad.
Use this dialog box to view the file size of Databases and their Projects and Networks, and view
the size of and delete Results.
Objects
Table 1-5. Database Space Utility
Field Description
Project Explorer pane Navigate through the Projects to view individual networks.
The size (and for child elements, the percentage of the parent) is
displayed.
Results pane For any Network that contains results, selected in the Project
Explorer pane, the Results are displayed in the Results pane.
The file size of each result is displayed.
You can select individual, multiple, or blocks of results and
delete them using the Delete button.
Tip: You can sort items in either pane on any of the properties.
Related Topics
Logon Configuration

October 2020
Introduction

To access: click the CONFIGURATION UTILITY button on the Database section of the
Launchpad and then choose either SQL or Oracle in the Database Type dialog box and click
OK.
Allows administrators to define databases, SQL user profiles, and configure licensing.
Objects
Note
You cannot use the Configuration Utility with Azure SQL Databases.
Table 1-6. Configuration Utility Dialog Box - SQL Option

Field Description
Attach Database Files Tab
SQL Server Name: • If you are using the SQL Server 2008 R2 Express version,
enter localhost\SQLEXPRESS.
• If you are connecting to a full SQL Server 2008 R2 data
server or Microsoft Azure database, enter the path to the
location of the database.
Database Name: Enter a name to identify the database, both in the SQL server
and to users selecting it in
Simcenter FlomasterSimcenter Flomaster.
MDF Full Path Name: Enter the path to the database definition file.
LDF Full Path Name: Enter the path the database log file.
Attach Database Click to create the database.
See Usage Notes below.
Configure SQL User Accounts Tab
Domain Enter the name of the domain in which the SQL server resides.
Username Specify a unique user name for the user within this domain.
Add User to SQL Server Click to add the user to the list of allowed users for the SQL
server specified on the Attach Database tab.
Account Path Displays the location that the SQL User account information
file is stored.
Table 1-7. Configuration Utility Dialog Box - Oracle Option

Field Description
Configure Oracle Database Tab
Host: The name of the Oracle server.

October 2020
Introduction
Table 1-7. Configuration Utility Dialog Box - Oracle Option (cont.)

Field Description
Port No: The Port number of the Oracle database.
Service Name: The Oracle service name on the server.
SYS User: Indicates the user and admin role of the database.
Set to SYS as SYSDBA
Password: The SYS User password required to log into the database as
SYSDBA
Tablespace File Path: The Tablespace file path on the server where the tablespace file
will be created.
(For example C:\oraclexe\oradata\XE.)
Dump File: Ensure that the server machine’s dump file is copied into the
dpdump folder.
(For example C:\oraclexe\app\oracle\admin\XE\dpdump.)
In this field enter the name of the copied dump file.
Usage Notes
When using the Attach Database Files tab to create a database, clicking Attach Database
results in a new database being created in the specified SQL server instance, based on the
schema contained in the .MDF file.
For more information on licensing Mentor Graphics software, refer to the FlexLM License
Administration Guide.
Related Topics
Logon Configuration

October 2020
Introduction

To access: Open the Options dialog box from Tools > Options... then choose the Logon and
Startup tab.
You can set log on options such as specifying that Simcenter Flomaster remembers the last used
license.
Objects
Option Usage
License Options
Remember on by default Setting this option displays the previously selected license.
To do this, click the associated check box.
Expand license sub-form by Setting this option expands the license sub-form to show all
default the license details
Database Options
Remember on by default Setting this option displays the previously selected license.
To do this, click the associated check box.
Expand database sub-form by Setting this option expands the database sub-form.
default 1. To choose a database server, click the Browse button. The
Select Database Server dialog box is displayed which
shows details of all the available servers.
2. Choose a database using the Database dropdown list.
Related Topics
Logon Configuration

October 2020
Introduction

October 2020
Chapter 2
Working With Simcenter Flomaster
Simcenter Flomaster is a software tool that can be used to model 1-dimensional thermo-fluid
systems. Within it, you can create virtual networks and model the behavior of these under
various conditions. You can use to model your existing “real world” systems to predict behavior
under varying conditions and system modifications, or when designing new systems, to develop
a virtual version before committing to building it.
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Logging on as a Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Changing Your Logon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Overview
Simcenter Flomaster contains the calculations, curves, and surfaces required to predict the
behavior of a range of fluid systems. These calculations are held in items called Component
Analytical Models (CAMs) which form the basis of “components”— the building blocks of
virtual fluid systems.
You simulate fluid systems as networks which comprise of connected components each with its
own set of results, such as:
• Volumetric Flow Rate

• Total Heat Flow
• Pressure
You can run different types of simulation (depending upon your license type):
• Incompressible: Steady State, Transient, Restart, Flow Balancing, and Priming

• Compressible: Steady State, Transient, Flow Balancing, and Restart
• Heat Transfer: Steady State and Transient
• Two Phase: Steady State, Transient, and Restart

October 2020
Workflow
Related Topics
Workflow
Architecture
Security
Workflow
Before attempting to model a fluid system you should consider the real system, the kind of
information you want to gain, and the level of detail you want the model to cover.
When modeling a fluid system you:
Procedure
1. Create a network and add components and nodes
2. Set the component and node data for the network
3. Set the simulation data and run the simulation
4. Review the results
5. It is recommended that you start with a simple version of the fluid system, review the
results, and then refine and repeat until you are satisfied that the results are of the
required accuracy
Related Topics
Overview
Architecture
Security
Architecture
Simcenter Flomaster can be installed in different configurations to support various numbers of
users.
Table 2-1. Installation Types

Installation Type Suitable For
Standalone Single users who rarely share project data with other users. Each
user will have an independent Simcenter Flomaster Database
running locally on their computer

October 2020
Architecture
Table 2-1. Installation Types (cont.)

Installation Type Suitable For
Team For small teams of users that work on the same projects. Users
have their own installation but share a single database. This
configuration enables users to easily share data, components and
models.
Enterprise For large teams of users who work on the same projects or need to
share a single source of enterprise project data.
This installation is similar to the Team Installation but the Database
Server (Microsoft SQL Server 2005 Standard Edition) is typically
run under the authority of the company System Administrator. For
Enterprise deployment it is anticipated that an IT coordinator will
manage the installation, possibly attaching a single (or limited
number) of Simcenter Flomaster databases to an existing central
Microsoft SQL Server database engine, using their own standard
management tools.
In this case, it will be the responsibility of this IT coordinator to
provide users with the required level of access to the central
Microsoft SQL Server database server engine and the
Simcenter Flomaster database.
Related Topics
Overview
Security

October 2020
Security
Security
Access to Simcenter Flomaster is protected by a user name and password combination.
Note
For information on the user logon process see “Starting Simcenter Flomaster” on page 29.
Administrators can set up users and permissions by either:
• Creating individual users, with individual permissions, within each project
Note
This is legacy functionality provided to support users upgrading from earlier
versions of Simcenter Flomaster. It is recommended where possible you manage
users by the user group functionality below.
• Creating users and adding them to user groups which are then assigned to roles
Logging on as a Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Changing Your Logon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Logging on as a Viewer
A Viewer License is a read-only license, enabelling users to view items in the database, inspect
certain data, and use the results. This option can be used, for example, to allow a user to view a
network created under a differnet license.
To use a viewer license when logging on, first select the a parent license (the one that was used
to create the networks and results that want to view) and then select the Viewer option.
Viewer License Functionality

A viewer license provides the following functionality:
Catalogues
You can view catalogues as defined by your user privileges. You can not make any changes to
the catalogues themselves or the catalogue data.
Networks
You can open any network that you have created or that has been shared with you. You can not
make any changes to the network schematic.
Component Templates
You can not make changes, such as plugging in new templates or removing templates.

October 2020
Changing Your Logon
Network Data
You can view the Network General Data on theSimulation Data tab. You can not make any
changes to data values.
Variable Parameters
You can view values or selections assigned to variable parameters on the Variable Parameters
tab. You can not make any changes to data values.
Simulations
You can not run a simulation on any network to which you have access. You can look at and use
the results for any network to which you have access.
Changing Your Logon

You do not need to close and re-open Simcenter Flomaster to change your logon.
Procedure
1. Select File > Change Logon. The Project Logon dialog box is displayed which provides
details of the current logon.
Note
If you are logged on at a branch of the project tree, roles from other branches will be
visible in the Elevate/Reduce Active Director Roles dialog box but disabled; you
cannot select them.
2. Click Yes to open the Launchpad.

3. Follow the steps in “Starting Simcenter Flomaster” on page 29).
Elevating or Reducing Your Role

You can, in certain circumstances, temporarily elevate or reduce your permissions without
logging out and back in again. This is useful when working across multiple Projects or
Networks.
Note
This functionality is only available if you have been set up as an Active Directory user by
your system administrator.
See Assigning Multiple Administrator Accounts in Active Directory for more information on
Active Directory user accounts
You can elevate or reduce your permissions to those of other roles in groups of which you are
already a member. For example, you are logged into Project A where you do not have

October 2020
Elevating or Reducing Your Role
permission to create a new network; rather than logging out and back in under a role that allows
the creation of networks, you can (as a member of group Group A, which has Network Create
permission) temporarily elevate your permissions to allow you to create a network.
The temporarily acquired permissions are only effective within the project where the roles are
defined (and any sub-projects).
You cannot elevate your permissions to allow you to:
• Perform User Administration activities

• Perform V6 Upgrade
• Access Script Databases
• Create Hybrid Results
For these you must login directly at the appropriate role.
Procedure
1. Select Tools > User Group Management > Elevate/Reduce Active Directory Roles
The Elevate/Reduce Active Directory Roles dialog box is displayed.
Note
If you are logged on at a branch of the project tree, roles from other branches will be
visible in the Elevate/Reduce Active Director Roles dialog box but disabled; you
cannot select them.
2. Select the Active option alongside the required Project/Roles and then click OK. Your
permissions are modified—within the appropriate project(s)—for the remainder of the
current session.

October 2020
Chapter 3
Managing and Working with Projects
You use projects to hold the networks and project data that you create. Each project has an
Owner. You can assign users to each project and, by assigning permission sets to each project,
you can give users different access levels and permissions within each project. Projects can be
shared out to other users.
For more information on user access and permissions see “User Group Management” on
page 747.
Creating a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Deleting a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Sharing Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Creating a New Project

You can create projects and use these to organize and manage networks and user access to them.
You can create projects from the Networks, Catalogues, Roles, or the Share tabs but the
procedure below describes creating a project from the Networks tab. The top-level project is
called Flomaster (or either FloMASTER or Flowmaster in installations that have been upgraded
from earlier versions). Any projects that you create will be nested below this project.
Prerequisites
• You must be logged into Simcenter Flomaster as an administrator to create projects.
Procedure
1. Click the Networks tab.
2. Select the project that you want to create a new project in.
3. Click the New Project button, . A new project called New project is created.
4. Type a new name for the project.

October 2020
The project properties are displayed in the bottom pane:

Figure 3-1. The Project Properties Table
5. To give the project a description:
a. Click in the cell adjacent to the Description field to expose the button.
b. Click the button to display the Description dialog box.

c. Enter a description and then click OK.
6. To set the units for the project:
a. Click in cell adjacent to the Unit Set field to expose the button.
b. Click the button to display the Select Unit Set dialog box.
c. Choose a unit set and then click OK.
7. To set the symbol set for the project:
a. Click in cell adjacent to the Unit Set field to expose a dropdown list button.
b. Choose a symbol set style.
8. To set the configuration set:
a. Click in the cell adjacent to the Configuration Set to expose the button.
b. Click the button to display the Select Configuration Set dialog box.
c. Choose a configuration and then click OK.
Related Topics
Deleting a Project
Sharing Projects

October 2020
Deleting a Project
Deleting a Project
You can delete projects from the Networks, Catalogues, Roles, or the Share tabs but the
procedure below describes creating a project from the Networks tab.
Prerequisites
• Only users who have Project creator permission can delete projects.
Note
You cannot delete a project that contains networks that have signed-off results. If
you attempt to do this a warning message is displayed. To delete a project that
contains networks that have signed-off results you must first unsign the results for the
network(s) and then delete the network(s). For information on unsigning results see
“Protecting Result Sets” on page 432
Procedure
1. Click the Networks tab.
2. Right-click on the project you want to delete and select Delete. The Delete Project
dialog box is displayed.
3. Specify Delete or Re-Assign by selecting the appropriate radio buttons for Sub Projects,
Owned Networks, Owned Data, Project Users/Roles.
Selecting Re-Assign for any of the above items will, upon deletion of the project,
transfer those items to the parent project.
4. Click the Proceed... button. A confirmation dialog box is displayed.
5. Click Yes to confirm deletion.
Related Topics
Sharing Projects
Sharing Projects
You can share projects to other projects. When you do this the project's networks are also
shared.
Prerequisites
To share a project you must have Project Share permissions (without Project Share Permissions
the roles tab will not be visible). For more information on setting permissions see User Group
Management

October 2020
Sharing Projects
Procedure
1. Click the Share tab in the Project View pane to display the Share pane.
Tip
You can open all items below a folder by highlighting the folder and then selecting
Expand All from the right-hand mouse button menu. To close all items below a
folder, highlight the folder and select Collapse All from the right-hand mouse button
menu.
2. Right-click on the project or sub-project you want to share and choose the Share option.
The Select Project to Share With: dialog, showing a list of projects and sub-projects, is
displayed.
3. Select the project that you want to share to.
4. To enter a description, click the Description button and enter a description in the dialog
box. Click OK to close the Description dialog box.
5. Click OK. The list expands to show the exported project has been added to the owning
project.
6. Set the Data Permissions, Network Permissions, and Results Permissions by selecting
either:
• 0. None
• 1. Read Only
• 2. read/Write
from the Value dropdown list (see table 3-1 for details of the relationship between Data,
network, and Results Permissions).
Table 3-1. Network and Data Permissions

Network Data Result Remarks
Permissions Permissions Permissions
Read Only Read Only Read Only The user can not:
• Run simulations
• Configure networks
• Edit component data
• Edit performance data (performance
data is owned by the shared project and
is read only)

October 2020
Sharing Projects
Table 3-1. Network and Data Permissions (cont.)

Read/Write Read Only Read Only The user can:
The user can not:
• Run simulations
is read only)
Read Only Read/Write Read/Write The user can:
• Run simulations
can be edited)
Read/Write Read Only Read/Write The user can:
• Run simulations
The user can not:
is read only)
Related Topics
Deleting a Project

October 2020
Sharing Projects

October 2020
Chapter 4
Managing and Working with Networks
Networks hold the components, connections, input parameters, and results. It is within networks
that you do most of your work in Simcenter Flomaster. You can create multiple networks under
each project.
Video
A video, Working with Large Networks, is available.
About Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Creating Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Copying and Moving Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Deleting a Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Searching for Items in the Network Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Attaching Items to Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Viewing, Editing, and Deleting Items Attached to Networks . . . . . . . . . . . . . . . . . . . . . 59
Sample Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Creating Your Own Sample Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Deleting Sample Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Network Window Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Configuring the Network Drawing window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Schematic Configuration Dialog Box - General Options Tab . . . . . . . . . . . . . . . . . . . . . . 67
Schematic Configuration Dialog Box - Setting the Pipe Properties . . . . . . . . . . . . . . . . . . 68
Schematic Configuration Dialog Box - Colour Control . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Schematic Configuration Dialog Box - Importing Background Images . . . . . . . . . . . . . . 70
Adding Text, Lines and Boxes to Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Adding and Managing Network Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Adding and Managing Lines and Boxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
About Networks
Simcenter Flomaster networks are virtual representations of a physical (or planned) network.
By joining components and specifying parameters, such as the fluid type or component volume,
you can predict the real world performance of a network.
Simcenter Flomaster networks can describe complete systems or part of a larger system.

October 2020
Creating Networks
Tip
You can open several networks at the same time and navigate between them using the tabs
along the top of the Network Drawing window.
Related Topics
Creating Networks
Copying and Moving Networks
Deleting a Network
Attaching Items to Networks
Viewing, Editing, and Deleting Items Attached to Networks
Creating Networks
You can create multiple networks.
Restrictions and Limitations
• You must have Network create permission.
Procedure
1. Click the Networks tab to display the Networks pane.
2. Select the project that you want to create the new network in.
3. Click the New Network button, .
A new network is created, its properties are displayed in the bottom pane, and the
Network Drawing window opens.
4. Enter a new name for the network.
5. To give the network a description:
a. Click in the cell adjacent to the Description field to expose the button.
b. Click the button to display the Description dialog box.

c. Enter a description and then click OK.
Related Topics
About Networks
Deleting a Network

October 2020

When you copy a network all of its components, parameters, results, and settings are also
copied. You can specify whether the copy is create at the same level or below (as a child of) the
original.
• You must have Network create permission to copy and move networks.
Procedure
1. Click the Networks tab to display the Networks pane.
2. Right-click the network that you want to copy and select Copy from the menu. The
network Copy Option dialog box opens.
3. Select one of the options:
• Child - the copy is create below the original
• Sibling - the copy is create at the same level as the original
• No - cancels the copy and closes the dialog box
The copy is create and given the name Copy of <name of original network>
4. To rename the network, select the network.
5. In the Network properties table, click in the cell adjacent to the name field and type in a
new name.
Note
You can drag and drop networks (including all parameters and results) from one
project to another provided that you have Network Creator access for the target
project. If you move a network which contains child networks, the hierarchy will be
maintained
Deleting a Network
You can delete networks. When deleted all results are also deleted.
You must either:
• Own the project to which the network belongs

October 2020
Searching for Items in the Network Tab
• Have administrator privileges

The Networks must not have signed off results - To delete networks with signed off results you
must first un-sign the results. For more information in signed off results see Protecting Result
Sets
Procedure
1. Right-click on the Network that you want to delete and select Delete from the menu. A
Confirm Deletion dialog box is displayed.
2. Click Yes to delete.
Related Topics
Creating Networks
About Networks
Searching for Items in the Network Tab

There are tools which can help you find items such as Projects and Networks in the Network
Tab.
Procedure
1. Select the Network Tab in the Project View pane.
2. You can create more space in the Network View pane by switching the Properties table
off. Click the button to hide the Properties table. Click the button again to show the
Properties table.
3. You can filter items according to their name. Type a word or part of a word in the Filter
text... field and only the items which contain that text in their name will be displayed.
Clicking the X button clears the filter.

You can attach items, such as documents, images and video files to networks.
The following file types are supported:
• Adobe PDF.pdf
• Crystal Report.rpt

October 2020
• Excel Spread Sheet.xls

• HTML Document.htm
• Notepad File.txt
• PowerPoint Presentation.ppt
• Rich Text Format.rtf
• Word Document.doc or .docx
• Bitmap.bmp
• GIF.gif
• JPEG.jpg
• PNG.png
• Audio Video Interleave (AVI).avi
Procedure
1. Click the + sign next to the network to see its sub-folders.
2. Right-click the Documents folder and select Upload Document(s) to display the Open
dialog box.
3. Navigate to the location of the file that you want to attach, select the file, and then click
OK.
The item is then attached to the Network and can be viewed from the Documents folder.
Related Topics
Creating Networks
About Networks
Deleting a Network
Viewing, Editing, and Deleting Items Attached

to Networks
You view items such as documents, images and video files which have been attached to
networks. You can also edit and delete these attached files.

October 2020
Procedure
1. Click the + sign next to the network to see its sub-folders.
2. Right-click the Documents folder and select either:
• Open Document for Inspection - Opens the document (using the computer’s
default program for that file type).
Note
If you make any modifications and attempt to save the file you will be prompted
to save a new copy locally.
• Open Document for Update - Opens the document (using the computer’s default
program for that file type). Any modifications that you made will be saved in the
attached version of the file.
• Delete Document - The attached document is deleted.
Caution
No warning is given on deletion
Related Topics
Creating Networks
About Networks
Deleting a Network

October 2020
Sample Systems
Sample Systems
Simcenter Flomaster contains example networks called Sample Systems. These demonstrate
how to model a range of applications using Simcenter Flomaster components.
Creating Your Own Sample Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Deleting Sample Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Exploring Sample Systems

You can browse, review, and unpack sample systems from the Simcenter Flomaster Launchpad.
Procedure
1. Select the Sample Systems group from the Launchpad.
Sample systems are listed with thumbnails.
2. You can create your own sample systems. See “Creating Your Own Sample Systems”
on page 62 for more information.
3. You can filter the list of Samples Systems by their title by typing in the text field at the
top of the list.
The Sample systems list is automatically filtered as you type.
4. You can learn more about a Sample system by either:
a. Moving the mouse pointer over a Sample System to display the tool-tip text.
b. Clicking on the Sample System thumbnail to open a summary page.
Click the button to return to the Sample System list.
c. Clicking the Icon to open a PDF which contains a summary, background

information, and usage examples of the Sample System.
5. You can unpack the sample system and then open it in Simcenter Flomaster. To do this
Click the button. Follow step 5 onwards from “Unpacking a Pack

File” on page 456.

October 2020
Creating Your Own Sample Systems
Creating Your Own Sample Systems

You can create your own Sample Systems and have them displayed, alongside the
Simcenter Flomaster Sample Systems, on the Launchpad.
Prerequisites
• A saved Simcenter Flomaster Network that is to become the Sample System.
Optionally, a PDF file with details of the Sample System and .jpg image file to use as the
Sample System thumbnail.
Procedure
1. Select the Sample Systems group from the Launchpad.
3. Type a name for the Sample System in the Title field. This can be different to the
network's name in Simcenter Flomaster and is the title displayed in the list of Sample
Systems.
4. You can add a description for the Sample System by typing in the Description field.
5. You can add an author for the Sample System by typing in to the Author field.
This is a free text field and does not need to match a Simcenter Flomaster User Name.
6. You can add application details and tags for the Sample System (for example Air
Conditioning or Fuelling) to help other users identify the use of the Sample System.
7. Attach the Network. To do this:
a. Click on the > icon on the Networks line of the NEW SAMPLE SYSYEM dialog
box to open the SELECT SYSTEMS dialog box.
b. Navigate to the Simcenter Flomaster network that you want to make a Sample
System and choose the Pack option next to the Network Name.
Note
You can attach more than one Network to the Sample System.
c. Click SELECT.
The name of the Network(s) is populated in the Networks field.
d. Click outside the SELECT SYSTEMS dialog box.

October 2020
Deleting Sample Systems
8. You can attach a PDF file to the Sample System which you could use to give users more
information and instructions about the Sample System. To do this:
a. Click the button next to Add PDF and use the Select PDF dialog box to
navigate to the PDF you want to attach.
b. Click Open to attach the file to the Sample System and close the Select Pdf dialog
box.
9. You can attach a Thumbnail image to the Sample System.
a. Click the button next to Add Image and use the Select Image dialog box to
navigate to the image that you want to attach.
b. Click Open to attach the file to the Sample System and close the Select Image dialog
box.
If you do not specify an image the default Simcenter Flomaster Sample System image
will be used.
Note
Images must be .jpg file type. 400 x 300 pixels are an ideal size but images of other
dimensions can be used and will be re-sized upon import.
10. You can use the; Lock Composites, Lock Performance Data, and Lock Scripts check
boxes to prohibit users of the Sample System from making changes to these features.
For more information see:
“Composite Components” on page 279 for information about Composite components.
“Component Application Models” on page 245 for information about Performance Data
“Catalogues - Scripts” on page 367 for information about Scripts
11. To Save the Sample System click the FINISH NOW button.
A confirmation that the Pack File has been created opens.
12. Click OK to close the confirmation message.
Results
The new Sample System will be displayed in the Sample System list.

You cannot delete the pre-installed Simcenter Flomaster Sample Systems but you can delete
user generated Sample Systems.

October 2020
Procedure
1. Navigate to the SampleSystems folder in the ProgramData folder. Usually, C:\
ProgramData\Simcenter\Flomaster\SampleSystems
2. Delete the FMPCK File for the Sample System that you want to delete.
3. Confirm the deletion on the Sample Systems group of the Simcenter Flomaster
Launchpad.

October 2020
Network Window Configuration
Network Window Configuration

You can change many of the display properties of the background and the way that components
are displayed in the network drawing window.
Configuring the Network Drawing window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Schematic Configuration Dialog Box - General Options Tab . . . . . . . . . . . . . . . . . . . . . 67
Schematic Configuration Dialog Box - Setting the Pipe Properties . . . . . . . . . . . . . . . . 68
Schematic Configuration Dialog Box - Colour Control . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Schematic Configuration Dialog Box - Importing Background Images. . . . . . . . . . . . . 70
Configuring the Network Drawing window

You can specify how items such as text, links, background and node colors, and pipes are
displayed in the Network Drawing window. You can also apply a background image to the
network.
Procedure
1. Select Schematic Configuration from the Network menu.
The Schematic Configuration dialog box opens.
2. Use the General Options tab to set:
• Link Properties (e.g. thickness and type)
• Text Options (e.g. network text, component text, etc).
• Grid Options (e.g. show grid, snap-to-grid, style, etc).
• Set the node capture area - Specifies how close to a node the cursor must be to link to
that node.
• Activate and set the time for the Network AutoSave function.
3. Use the Pipe Configuration tab to set:
• Pipe inner and outer colors.
• Pipe Width.
• Pipe Style (straight or flexible).
• Pipe Label (show or hide pipe text labels).
• Adjusting Style - Specify how pipe components move when stretched or are
positioned in the Network Drawing window.

October 2020
Configuring the Network Drawing window
• Lock Pipe Waypoints

4. Use the Color Control tab to set:
• Background Color.
• Node, Port, and Link colors.
5. Use the Image import tab to specify an image to display on the background of the
Network Drawing window.
For example, you could add a background of a circuit produced by a CAD package and
then overlay the image with Simcenter Flomaster components.
6. To apply any changes click the Apply button. To close the dialog box click OK.

October 2020
Schematic Configuration Dialog Box - General Options Tab
Schematic Configuration Dialog Box - General

Options Tab
Use the General Options tab of the Schematic Configuration Dialog box to set the link and text
properties and set the grid options.
Objects
Table 4-1. The Network Configuration Settings
If you want to... Do the following
Link Properties
Set the link thickness Click the dropdown list and select the required value.
Set the default link type Click the required radio button.
Set the avoid nodes option ON/OFF Click the associated check box.
Text Options
Set the networ, component, or node Click the associated check box.
text ON/OFF
Set the component node ID ON/OFF Click the associated check box.
Set the Default Network Font 1. Click the button to display the Font dialog box.
2. Select the required font, style, size, etc and then
click OK.
Set accuracy of results/data when Click the required check box and then click the
displayed in network drawing window dropdown list to select the required setting.
Grid Options
Set the Show Grid, Snap to Grid and Click the associated check box.
Ruler options ON/OFF
Set the Grid Color 1. Click the button to display the Color dialog box.
2. Select the required color and then click OK.
Set the Grid Style Click the associated dropdown list and select the
required style.
Set the Grid Width
Set the Grid Cell Size Enter the required value.
Node Selection Options
Activate the Node Selection option 1. Click the check box.
2. Move the slider control left or right to either
decrease or increase the capture area.
Schematic Options

October 2020
Schematic Configuration Dialog Box - Setting the Pipe Properties
Table 4-1. The Network Configuration Settings (cont.)

Activate the AutoSave option 1. Click the check box.
2. Click the dropdown list and select Yes.
Usage Notes
To apply and save your changes click Apply then OK.
Schematic Configuration Dialog Box - Setting the

Pipe Properties
Use the Pipe Configuration tab of the Schematic Configuration dialog box to change the color
and behavior of the pipe components in the Network Drawing window.
Procedure
1. From this form you can:
Table 4-2. The Network Configuration Settings

Set the pipes' inner and outer colors 1. Click the required button to display the Color
Dialog Box.
2. Select the required color and then click OK.
Set the pipe width Click the dropdown list and select the required
value.
Note: The Pipe Width setting controls how the
pipe is represented in the Network Drawing
window - not to be confused with the physical
diameter of the pipe to be modeled.
Set the default pipe style Click the required radio button.
Set the pipe label

October 2020
Schematic Configuration Dialog Box - Setting the Pipe Properties
Table 4-2. The Network Configuration Settings (cont.)

Set the default adjusting style End Style option for pipes enables you to move one
end of a pipe, relative to a 'way point'. When you
select the pipe, two handles are displayed, one at
each end of the pipe. By grabbing a handle you can
move the end of the pipe to the required position.
The Scale option enables you to scale a pipe,
relative to a 'way point'. When you select the pipe,
two handles are displayed, one at each end of the
pipe. By grabbing a handle you can scale the pipe to
the required setting.
The Stretch option enables you to stretch a pipe.
When you select the pipe, two handles are
displayed, one at each end of the pipe. By grabbing
a handle you can stretch the pipe to the required
setting.
2. When you have finished, click Apply then OK.

October 2020
Schematic Configuration Dialog Box - Colour Control
Schematic Configuration Dialog Box - Colour

Control
Use the Colour Control tab of the Schematic Configuration dialog box to change the color of
components and connections in the Network Drawing window.
Objects
• Background Colour
The color of the Network Drawing window’s background.
• Node Colour
Specify the color of the Solid, Hydraulic, and Mechanical nodes.
• Port Colour
Specify the colors of the different port types.
• Link Colour
Specify the colors of the Mechanical, Signal, Solid, and Incompressible links.
Usage Notes
Clicking on any of the named buttons (for example Signal In will open the Color dialog box).
From there select one of the basic colors or define a custom color. Click OK to save the new
color and apply it.
Schematic Configuration Dialog Box - Importing

Background Images
You can specify a background image for the Network Drawing window. You can use this to, for
example, import an engineering diagram and then overlay the Simcenter Flomaster components
on the background image.

October 2020
Using the Rendering Configuration Dialog Box
Procedure
1. From the Image Import dialog box you can:
Table 4-3. Importing Background Images

Import a background image 1. Click the Browse button. The Open dialog box is
displayed.
2. Navigate to the required folder and select the image,
which can be in one of the following formats:
a. .bmp
b. .gif
c. .jpg
3. Click Save to save the image
Specify the document units Click the dropdown list and select the required units (e.g.
pixels, millimeters, etc).
Specify the image size Click in the adjacent cells and enter the required 'X' and 'Y'
values.
Specify a scaling factor Click in the adjacent cell and enter the required value.
2. Click Apply then OK.

You can specify how the text, grid, and components in the Network Drawing window are
rendered when you zoom in and out. You can also specify the contrast of Network Drawing
window text.
You can set:
• How links are represented when zooming out

• How text is represented as the scale reduces
• How the grid is represented as the scale reduces
• How the visible components are rendered
• How the rendering quality is affected as the zoom scale decreases
• The contrast of the text.
Select Render Configuration from the View menu to open the Rendering Configuration dialog
box.

October 2020
Figure 4-1. The Rendering Configuration Dialog Box
To set a configuration enter the required value and click OK to save and close the dialog box.

October 2020
Adding Text, Lines and Boxes to Networks
Adding Text, Lines and Boxes to Networks

You can add comments to the network and specify how components and nodes are labeled and
numbered. You can also add lines or boxes to the network, to highlight parts of interest.
This video illustrates the basic steps for displaying and hiding component and node descriptions
and adding text, lines, and boxes in the Network Drawing window.
Adding and Managing Network Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Adding and Managing Lines and Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

October 2020
Adding and Managing Network Text

You can add text to a network and specify how component and nodes are labeled in the Network
Drawing window.
Inserting a Comment in the Network Drawing window . . . . . . . . . . . . . . . . . . . . . . . . . 74
Moving Comments and Text Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Displaying and Suppressing Component Names and IDs . . . . . . . . . . . . . . . . . . . . . . . . 75
Displaying and Suppressing Node Names and IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Text Alignment Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Inserting a Comment in the Network Drawing window

You can add comments to the network. These can provide explanatory information or further
information about the choice of components.
Procedure
1. Click the Annotation Mode button, , on the Schematic toolbar.
2. Click the Insert Comment button, , on the Schematic toolbar. The cursor changes to
a pencil symbol.
3. Click on the network background. A text box opens containing the default text “Insert
your multiline comments here”.
4. Click the text to open the text box, delete the default text and type a comment.
5. Select the Pointer Mode button, , and click on the network background to save the
note and close the text edit box.
6. You can specify the font, size, and color of the text from the Font toolbar.
Moving Comments and Text Labels

You can move inserted text comments and component and node text labels.
You can move these items individually or as a group.
Procedure
2. Select the comments that you want to move.

October 2020
Tip
You can draw a regoin around all that you want to select.
3. Click the Move Text button. The cursor changes and the Move Text Options dialog
box is displayed:
Figure 4-2. The Move Text Options Dialog Box
4. Select the Individual or Selection.

5. Select Move in the text Location group and click OK.
6. Click on the items you want to move and drag them to the new location.
7. To reset moved items:
a. Click the button to display the Move Text Options dialog box
b. Select the Reset option and click OK
Displaying and Suppressing Component Names and IDs

You can specify whether component names and IDs are displayed on the network or not.
Procedure
1. To display or suppress the component names, click the button.
2. To display or suppress the component IDs, click the button.

IDs are displayed alongside the component name.

October 2020
Adding and Managing Lines and Boxes
Displaying and Suppressing Node Names and IDs

You can specify whether node names and IDs are displayed on the network or not.
Procedure
1. To display or suppress the node names, click the button.
2. To display or suppress the node IDs, click the button.
IDs are displayed alongside the node name.
Text Alignment Options

There are tools which help you to quickly align inserted text comments on the network.
Prerequisites
• Ensure that Annotation Mode is enabled. If it is not click the Annotation Mode button,
, on the Schematic toolbar.
Procedure
1. Use the mouse to draw a box around the items that you want to align.
2. Select Align from the Views menu.
3. Select one of the following options:
• Align Horizontally
• Align Vertically
• Align Left
• Align Right
• Align Top
• Align Bottom.
The items are aligned according to your choice.

You can add lines and boxes to the network Drawing Window. You can use these to draw
attention to sepcific areas of the Network.
Procedure

October 2020
2. To add a line to the Network Drawing window:

a. Click the Draw annotation line button, , on the Schematic toolbar.
b. Use the cursor to draw a line.
Note
The Snap to Grid option (if active) will affect the exact poitioning of the line.
3. To add a rectangle to the Network Drawing window
a. Click the Draw annotation rectangle button, , on the Schematic toolbar.
b. Use the cursor to draw a rectangle.
Note
The Snap to Grid option (if active) will affect the exact poitioning of the
rectangle.
4. To move and format lines or rectangles:

a. Select the objects that you want to move or format by using the mouse to select
individual items or by drawing a box around all the items that you want to edit
Note
You can format lines and rectangles at the same time.
b. Move items by dragging and dropping them to their new location.

c. To format lines and rectangles, right-click over any selected item and select Style....
Use the Style dialog box to specify the color, line thickenss, or line style. Click OK
to close the Style dialog box.
5. To delete lines or rectangles:
a. Use the mouse to select the items that you want to delete.
b. Select Delete from the Right-hand mouse button menu.
Results
Note
Lines and rectangles are created as a layer, which you can manage (hide, display, lock, and
edit the color and transparency) from the layer management tool , .

October 2020

October 2020
Chapter 5
Modeling Networks
Simcenter Flomaster networks are made up of components connected together via nodes. Each
component is mathematical representation a physical item. Once you have created a network
and set some conditions for the model you can run a simulation and generate results.
Networks - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Network Modeling Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Incompressible (Non-Hydraulic Power) Modeling Rules . . . . . . . . . . . . . . . . . . . . . . . . . 81
Compressible Flow Modeling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Hydraulic Power Modeling Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Components, Nodes, and Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Building a Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Switching the Snap To Grid On or Off. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Renumbering Components and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Moving Around the Network Drawing window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Zooming in and Out of the Network Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Using the Catalogue Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Connecting Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Connections and Their Meanings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Deleting Components and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Replacing Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Component Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Setting Component Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Using the Collection List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Layer Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

October 2020
Modeling Networks
Networks - Overview
About Layers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Networks - Overview
Before attempting to model a fluid system in, you should consider the real system, the kind of
information you want to gain, and the level of detail you want the model to cover.
When modeling a fluid system you:
1. Create a network and add components and nodes

2. Set the component and node data
3. Set the simulation data and run the simulation
4. Review the results
Tip
It is recommended that you start with a simple version of the fluid system, review the
results, and then refine and repeat until you are satisfied that the results are of the required
accuracy.

October 2020
Modeling Networks
Network Modeling Rules
Network Modeling Rules

There are some basic rules which apply to all types of Simcenter Flomaster networks.
• There is no limit to the number of components that you can connect to a node.
• There can be only one pressure specifying component connected to any node.
• The network (or any isolated part of a network) must contain at least one pressure
specifying component.
Incompressible (Non-Hydraulic Power) Modeling Rules . . . . . . . . . . . . . . . . . . . . . . . . 81
Compressible Flow Modeling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Hydraulic Power Modeling Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Incompressible (Non-Hydraulic Power) Modeling

Rules
There are some rules which are specific to Incompressible (Non-Hydraulic Power) networks.
Node Connections
The node type should be set to either:
• AC
• Humid Air
• Incompressible.
Pressure Specifying Components
• If your network contains an accumulator or tank (and there are no other pressure
specifying components in the network) you must set it to operate in a pressure defining
manner (for example, liquid level set).
Unconnected Networks
• You can not run simulations on networks that have parts which are totally unconnected.
You can be resolve this by either:
o Connecting to another part of the system.
o For Steady State Simulations - connecting to a reservoir via a control valve
component. If you intend to develop the model to a transient simulation type, the
control valve can be set to close during the first time step.

October 2020
Modeling Networks
Incompressible (Non-Hydraulic Power) Modeling Rules
o Joining the unconnected sections together with a valve component which will ensure
that the pressure is communicated across the two sections whilst flow between them
remains zero. Note that each section must have a pressure specifying component.
o Connecting the sections together using a common pressure specifying component, a
Thermal Bridge component, or a Thermal Heat Exchanger component.
Related Topics
Compressible Flow Modeling Rules
Hydraulic Power Modeling Rules

October 2020
Modeling Networks
Compressible Flow Modeling

The Compressible Flow Steady State and Transient modules have been specifically designed for
modeling gas systems but can also be used to model liquid systems and certain types of liquid/
gas systems.
Compressible Flow Modeling Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Using Compressible Flow Transient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Improving Compressible Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Both modules use components from the Simcenter Flomaster database. Each of these
components represents a mathematical model of an engineering component. Selected
components are connected via nodes to form a network, which forms the actual computer model
of the flow system.
Data, curves and surfaces can be used to define the operation and performance of each
component. Once the model has been set up, you can run a simulation and look at the results.
Example applications include modeling:
• Gas supply and distribution systems

• Gas bottling systems
• Compressor station systems
• Pipeline breaks
• Using Flow Balancing to specify the required mass flow rates in a network. Having done
this, Simcenter Flomaster calculates the pressure and flows in the network and
determines the relavent component data and enables the required flows to be achieved.
Node Connections
The node type should be set to either:
• Compressible - for the dry side of the network.

• Incompressible - for the wet side of the network.
You should not use the nodal temperature data as input data.

• Compressible flow networks often terminate with either a gas storage vessel or
discharge to a fixed pressure. It is advisable to model this by using a pressure specifying
component.

October 2020
Modeling Networks
• If you expect your network to choke, it is advisable to specify a downstream pressure (to
prevent an undefined downstream pressure error during simulation).
Flow Specifying Components
• Specifying flow at the downstream end of a network, may result in the simulation failing
to achieve a solution. This usually seen in choked systems when the downstream (of the
choked component) pressure is undefined.
• Ensure that flow rates at the downstream end of a choked network should be realistic,
since flow rate through this type of system will be governed by upstream pressure.
Flow and Pressure Sources
• You can not connect a flow source and a pressure source to the same node.
Related Topics
Using Compressible Flow Transient

Compressible flows are highly complex physical phenomena. Modelling such phenomena with
numerical techniques involves making approximations and using sophisticated numerical
methods to solve the resulting sets of equations.
Simulating compressible flow systems within a network of Simcenter Flomaster components
therefore represents a demanding modeling task. Further, transient simulations are more
difficult to perform than steady state simulations.
The following discussion is not an authoritative statement of any of the numerical methods used
by Simcenter Flomaster. Instead, it introduces users to some of the subjective judgments that
can make numerical simulations even more effective.
The notes are designed to minimize the risk that users' simulations are significantly affected by
numerical errors. Such errors can arise from a number of factors, such as:
• Possible failures in the numerical conservation schemes for the mass, momentum or
energy equations
• Growth in instabilities
• Failure to converge to a stable and accurate solution
By reviewing the modeling assumptions, users can significantly reduce the likelihood that such
factors affect their simulation.

October 2020
Modeling Networks
The advice is tailored to the user. References such as 'Numerical Recipes in C. The Art of
Scientific Computing' 11 can provide more thorough general background on numerical
techniques for interested users.
The transient compressible flow modules have been derived from a consideration of unsteady
flows in gas pipeline systems. A paper by Thorley and Tiley 2describes much of the theoretical
basis for compressible flow simulations.
Thorley and Tiley note that modern gas recovery and pipeline systems seldom operate under
steady flow conditions. They recommend that the design and simulation of such systems are
based on the premise of unsteady flow. Further, for simulation purposes, they observe that the
study of such flow systems may be divided into two main categories: slow and rapid transient
events.
Slow transients are those fluctuations caused by changes in pressure and flow due to changes in
demand. They are mainly concerned with the packing and unpacking of gas in the system
Rapid transients are those fluctuations caused by a line break, i.e. a pipe rupture, compressor
failure, rapid shut down or start up of a system.
The paper describes the basic equations for homogeneous compressible flow, and their solution
by the Method of Characteristics (MOC).
Simcenter Flomaster uses a mesh Method of Characteristics. This overcomes one of the main
drawbacks of the natural Method of Characteristics. The natural method requires a potentially
complicated two-dimensional interpolation in the characteristic net, if the dependent variables
are solved at fixed time intervals. The mesh method avoids this. It solves the characteristic
equations on values for the dependent variables at specified time-distance co-ordinates.
Whereas the natural Method of Characteristics is unconditionally stable, the mesh Method of
Characteristics is only conditionally stable. The stability criterion is due to Courant-Friedrichs-
Lewy (CFL). This may be expressed in terms of mesh dimensions. If the Courant Number is
defined as a, the CFL stability criterion is given by:
(5-1)
where:
u = Velocity of the gas
1. Press, W.H., Teukolsky, S.A., Vetterling, W.T., and Flannery, B.P. ‘Numerical Recipes in C. The Art of
Scientific Computing’ Cambridge University Press. Second Edition. 1992
2. Thorley, A.R.D, and Tiley, C.H. ‘Unsteady and Transient Flow of Compressible Fluids in Pipelines - A
Review of Theoretical and some Experimental Studies’ Int. J. Heat and Fluid Flow 8 (1), March 1987.

October 2020
Modeling Networks
as = Isentropic wavespeed
Δt = Time step
Δx = Distance along the pipe
Ma = Mach number
The CFL stability criterion provides the basis for the automatic calculation of the time step by
Simcenter Flomaster for Transient simulations. For calculating time steps, Simcenter Flomaster
takes a value for a as 0.9.
For the mesh method, there are certain circumstances when numerical dispersion of the waves
occurs even with adherence to the stability criterion. For example, problems can arise at high
Mach numbers, or when the wavespeed varies significantly along the length of the pipe.
Thorley's observation that flow simulations are best characterized as either slow or rapid
transient events has an important bearing on the time step. Smaller reach lengths and time steps
are needed to resolve developing pressure waves associated with rapid events than would be
required to resolve those associated with slow events.
Modelling rapid events in a system can take much more computational effort than slow events
in the same system. For example, modeling the consequences of a burst in a 30 km gas
distribution pipe will take much more effort than modeling the normal variations in the flow of
gas due to changes in demand through the same pipeline.
Component Results
Most component results contain the quantity 'Total Heat Flow'. This is scaler quantity and is
defined as:
(5-2)
Where:
ṁ = Mass flow Ratecp = Specific heat capacity at constant pressure TRe = Temperature of fluid
at component branch T0 = Reference temperature of fluid (if set) or Ambient Temperature of
the network
It represents the heat content of the fluid relative to the Reference Temperature of the fluid (if
set) or the Ambient Temperature of the network.

October 2020
Modeling Networks
Static Pressure/Temperature
Static pressure is available as a component result. The static pressure is the total pressure less
the dynamic pressure (or velocity pressure).
The dynamic pressure tends to a value of 1/2ρv2 as the Mach Number approaches zero. At
higher Mach Numbers, it is given as:
(5-3)
Improving Compressible Models

Even with apparently successful simulations, a review of the model is recommended,
particularly If, for transient simulations, with steady Flow and Pressure Sources, the mass
inflow rate to the system does not match the mass outflow from the flow system, and there is no
evidence of 'packing' or 'unpacking' in the flow lines, or significant random fluctuations are
observed either in the mass flow rates through components, or in the total pressures measured at
the internal nodes.
Factors which may need to be considered in the review of the model include:
• The basic modeling assumptions

• Reach length considerations
• Time step considerations
• Mach number considerations
• Stability considerations
• Other strategies for successful modeling
• Supersonic or choked flow considerations
Strategies for Developing Successful Compressible Flow Models

Simcenter Flomaster can be used to simulate a diverse range of engineering flow applications.
Determining the valid boundaries for a particular model developed will largely depend on what
the you are trying to achieve. So, the document can only give the following basic guidance on
modeling strategy.

October 2020
Modeling Networks
Basic Modeling Assumptions

1. It is important to define the goals for the model, such as:
o What is the model supposed to demonstrate?
o Will rapid transient events such as pipe rupture or sudden valve closure occur?
o Is the objective to study slow transient events such as changing demand on gas
distribution systems?
2. If any rapid transient event is expected the model must be designed to capture this event,
even if the perturbations only last for a short time.
3. Use a staged approach to model development. Start with simplified models of the
system. Only increase the complexity of the overall network model as understanding of
the components' behavior improves for the applied flow and pressure boundary
conditions.
4. Perform sensitivity studies with your models. Do not just rely on single simulations to
produce a definitive answer. Varying the magnitudes of flow and pressure sources by
representative amounts will show how sensitive the system is to change.
5. Investigate ways of independently verifying the model. For example, might the use of
different modeling assumptions give similar results? With gas packing or unpacking
problems, it may be worth considering using rigid pipes combined with gas bottle
accumulators in place of an elastic pipe? (The internal volumes of the two systems will
need to be equivalent.)
Reach Length Considerations

1. As an approximation, in the first modeling attempts, aim to have similar reach lengths
(within a few percent) in all pipe components. Try to avoid long and short elastic pipes
in the same overall model. If you have differing lengths of pipe, try to pick the number
of nodes in each pipe so that the reach lengths are uniform throughout the system.
2. Consider making reach lengths, l, 'big', i.e. node numbers small, to maximize time steps
(from the CFL limits) and thus minimize computational time. If 'satisfactory' results are
obtained, make experiments with small reach lengths and time steps.
3. The closer together the nodal points are, and the slower the changes in pressure, the
more stable the solution. As an approximate guide, it is suggested that the reach length is
such that:
(5-4)

October 2020
Modeling Networks
Where:
I = The reach length [L/(N+1)]
L = Pipe length
N = Number of nodes
d = Pipe diameter
4. Stable simulations have been performed on slow transient events with an l/d of 200.
However, users simulating gas transmission pipelines (which are several kilometres
long) may even consider increasing the l/d ratio to 1000 for practical convenience.
Providing there are no rapid transient events, such as a pipe rupture, it should be possible
to perform stable simulations with acceptable numerical errors at this l/d ratio.
5. For high speed flows, it may be worth exploring the effect of decreasing reach length in
the direction of increasing Mach number. For pipes with an exit Mach number greater
than 0.6, check the effect on the results of setting l/d to 10, and then to 1.
Time Step Considerations

1. Identify the pipe component constraining the time step. For the given lengths, diameters
and reach lengths, the CFL stability criteria can be calculated for each pipe. Estimates of
sonic velocity and Mach number can be taken from the steady state results of the system.
It should be noted that during the transient simulation, as conditions in the system vary,
the pipe component which constrains the time step may change from the steady state
results. Simcenter Flomaster will automatically reduce the time step to meet the stability
criterion for the new constraining pipe.
2. Once identified, the modeling assumptions which were made for the constraining pipe
can be reviewed with a view to minimizing - or even removing - the effect of the
constraint.
3. Based on the CFL limits, consider investigating the effects of the time step. Experiment
with variations to the time step limit determined from the CFL stability criterion, e.g. try
a time step calculated from:
(5-5)
with ft being a 'time-factor' which can be taken as 0.5, 0.75, 1.0, or even, 1.1. Use the last
value with great caution; it is above the normal CFL stability limit.
4. We have had reports that improved results are obtained if the time step is set to
correspond with ft = 0.5 in the above equation. This is contrary to our normal

October 2020
Modeling Networks
recommendation, which is to set Δt such that ft tends to 1. This normally minimizes the
numerical errors associated with the solution method.
5. If you are concerned that the selected time steps may cause problems, another way to
establish this may be to run a Steady State simulation followed by an equivalent
Transient simulation, with the same steady boundary conditions as for Steady State. If
the time step is inappropriate, differences in mass flow between inlet and outlet might be
observed. With this device, it may be possible to establish how important a factor this is
to your model.
Mach Number Considerations

1. The method of characteristics may experience imbalances between mass inflow and
mass outflow as the reach length becomes larger and/or the Mach Number increases,
without a corresponding change in the accumulation term associated with the control
volume. Above a Mach Number of ≈ you may need to decrease the reach length (i.e.
increase the number of internal nodes) to prevent significant imbalances between mass
inflow and outflow for the pipe component.
2. If you are affected by this phenomenon, it may be necessary to use an l/d significantly
less than 100 to prevent significant mass flow imbalances.
3. The change in Mach number between nodes is an important factor in calculation
accuracy. Large changes in Mach number along a reach length can potentially lead to
large numerical errors. Given the almost exponential increase in Mach number with pipe
length in steady flows, it follows that particular attention must be paid to the reach
lengths at the exit end of the pipe. This is especially important for high Mach number
flows.
4. Ideally high, rapidly changing Mach number flows would be modeled in short pipes
with tightly packed nodes and would run with a short time step.
Other Considerations for Successful Modelling

1. Check the operating conditions for the flow system against the phase diagram for the
process fluid.
2. It is advisable to check that the compressible gas flow system is operating away from the
two-phase (liquid-gas) or liquid region. It is conceivable that whilst iterating to a
solution, intermediate values of temperature and pressure cause the Eagle database to
look up inappropriate values of physical properties. For example, liquid densities might
be returned when gas values are really expected. This would significantly affect the
march to convergence.
3. There are occasions when using a different heat transfer model, i.e. Compressible flow
process, can radically affect the success of the modeling. We have seen, with some
'simple' networks, that changing from adiabatic simulation (flow process 4) to full heat

October 2020
Modeling Networks
transfer (flow process 5) can significantly change the outcome of the model. Where
mass imbalances were seen, the model now behaves well.
4. If gas packing, or unpacking, i.e., modeling a slow transient event, consider replacing
elastic pipes with a combination of rigid pipes and gas bottle accumulators. (The rigid
pipe model is activated by setting the 'Elastic Model' option for pipe data equal to 2 -
'No'.)
5. Pipes with this data setting will model transient behavior with no elastic or inertial
effects. This can be a perfectly valid model in other circumstances, such as for rapid
events in short networks, where the gas mass in the pipe is only a small proportion of the
total gas mass in the system. You can have both rigid and elastic pipes in the same
network.
6. Consider using the rigid pipe model for short pipe lengths of pipe. They have no
constraining effect on the simulation time step, so they can be used where the use of an
elastic model would necessitate a very small time step, Δt.
Supersonic or Choked Flow Considerations

Simcenter Flomaster does not model supersonic flows within compressible (internal) flow
systems.
Once the flow is predicted to be choked, the Mach number will not exceed 1. The pressure
distributions anywhere downstream of a choked position (where Ma = 1) will show the greatest
deviations from the expected or observed values.
There are a number of checks which may necessary:
Geometry Checks
1. Check internal and external diameters for all pipe components: sometimes nominal pipe
diameters are used incorrectly for internal diameters.
2. Check l/d ratios of pipe components:
a. In near-supersonic/transonic systems with diffusers we do not expect significant
boundary layer effects, so l/d can be < 30
b. If boundary layer development is thought important, l/d should be > 30.
Area Checks
Check flow areas for all other components, i.e. bends and diffusers. Ensure that connected
branches have identical flow areas.
Friction Factor Check

Is an appropriate friction model used for pipes?

October 2020
Modeling Networks
Compressible Transient - Solution Methods
Verify Diffuser Loss Curves

Because Simcenter Flomaster does not consider internal supersonic flows, the supplied loss
curves for diffusers do not adequately represent and account for the supersonic conditions
downstream of the Ma = 1 throat, or the effect of the strong shock which might be expected just
downstream of the throat.
Taking account of these factors for supersonic flow is not a trivial exercise.
Component Results Check

Checks on pressures, temperatures and flow-rates by component.
Sensitivity Checks
Perform sensitivity simulations for:
• Flow sources
• Pressure sources
• Line internal diameters.
This will help to give greater confidence in the particular set of data which you want to form the
basis of your results.
Critical Pressure Ratio Checks

To improve confidence in your studies, it may be helpful to calculate the critical pressure or
area ratios for the operating pressures, temperatures and areas of your system. You can compare
Simcenter Flomaster predictions against these numbers.
Concluding Remarks
Transient compressible flows are highly complex physical phenomena. Simulating these flows
within a network is a demanding modeling task. But it is possible to significantly to improve the
quality of such simulations - and get good results - by having a clear idea of what the model is to
represent, in terms of the physical processes involved, the components to be used, and the
objective of the study and by adopting a systematic, staged approach to model development.

The solution method for the simulation of 'non-pipe' components, including thermal capacity is
given here.

October 2020
Modeling Networks
energy Equation
Taking a control volume around a single component, the energy equation may be defined as
follows:
(5-6)
Where:
ΔE = Accumulation term
δe1 = Transport term - In
δe2 = Transport term - Out
δ0 = Energy loss (by radiation/conduction/convection)
δw = Work done on the fluid to overcome pressure forces
Assuming that the mass into the component over the time step is equal to the mass out of the
component, i.e., ignoring the effect of mass accumulation within the component, then:
(5-7)
The transport terms may therefore expressed as:
(5-8)
Equation 3
Where:
= The integrated value of specific heat over the temperature range T0 - T
T0 = Reference temperature

October 2020
Modeling Networks
δe0 = Thermal energy at the reference temperature
= Average value of temperature over the time step which is given by:
(5-9)
Hence:
(5-10)
Accumulation Term
Simple components will be considered to operate as if perfectly mixed. This assumption means
that the component temperature will be equivalent to the fluid temperature at exit. Hence the
accumulation term may be expressed as follows:
(5-11)
Where:
ML = Mass of the contained fluid (= Volume x Density at time t)
MS = Mass of the solid material associated with the component
cp22 = The integrated value of liquid specific heat over the temperature range T2(t) - T2 (t + δt)
cps22 = The integrated value of solid specific heat over the same temperature range

October 2020
Modeling Networks
Heat Loss Term

The heat loss to the surrounding atmosphere by conduction, radiation and convection is based
on an average component temperature taken from the inlet and outlet flows:
(5-12)
Where:
h = An overall heat transfer coefficient
A = The surface area through which heat transfer takes place
TEXT = The external temperature
Frictional Heating Term

The frictional heating term may be expressed as follows:
(5-13)
Where:
P = Average value of the total pressure over the time step
ρ = Average value of the density over the time step
Solution Method
Given the starting values of T1 and T2, plus a full description of the component and the physical
properties of the fluid and the solid, it is possible to use the energy equation to solve directly for
T2 at time t = δt. The dependence of specific heat on the solution requires that an iterative
solution be adopted. This is incorporated into the main iterative solution procedure, i.e., the
algorithm for T2 (t + δt) will use the 'current' specific heat values, which will progressively get
more accurate as Adopt a systematic, staged approach to model development. converges to a
solution.
Aside from additional data requirements and a calculation sub-routine embodying the above
algorithms, the only additional design/data requirements is that a new data array be set up to
hold temperature values at the last time step.

October 2020
Modeling Networks
Total Heat Flow

This value is output as a result for each branch of the component. The reference temperature is
the temperature value set on the Ambient Conditions sub-form.

There are some rules which are specific to Hydraulic Power modeling networks.

• Closed loop circuits are commonly used in Hydraulic Power systems. If the network (or
sub-circuit) contains an accumulator or tank, you must ensure that it operates in pressure
defining manner (e.g. liquid level set).
• You can not run simulations on networks that have parts which are totally unconnected.
You can be resolve this by either:
o Crack open one of the valves/channels isolating the section. This ensures that the
pressure is communicated whilst the flow remains zero (since there is only one flow
path to the isolated section).
o For Steady State simulations - connecting the loop via a control valve component to
another part of the system or reservoir. If you intend to develop the model to a
transient simulation type, the control valve can be set to close during the first time
step.
o Including a loss connections such as a tank case drain in the network
Flow Lines
Separate flow lines must be connected even if there is no fluid flow required between them for
the system to operate. You can resolve this by either:
• Including a closed control valve.

• Providing both parts of the network a common pressure specifying reservoir or pressure
source.
Related Topics

October 2020
Modeling Networks
Components, Nodes, and Materials
Components, Nodes, and Materials

Adopt a systematic, staged approach to model development. contains a range of components
and materials which you use to create a realistic network. You can also create your own custom
components and materials.
Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Components
The Simcenter Flomaster database contains a range of components that can be used in
Compressible and Incompressible (Hydraulic and Non-hydraulic Power) applications. Each
component represents a mathematical model of an engineering component.
Components are grouped into catalogues, the catalogues that you can see will depend upon your
license. For example, to see the Aerospace Components catalogue you must have an Aerospace
license.
Note
The paths of Catalogue folders, Analytical Models, Components, Materials, Performance
Data, Scripts, Sub-Systems, and Symbols are displayed in the Catalogue properties pane.
The Component catalogues available (regardless of license type) are:
• Accumulators
• Advanced Tanks
• Aerospace Components
• Air Conditioning - Advanced
• Air Side
• Automotive Components
• Bearings (Lubrication)
• Bends
• Diaphragms
• Cylinders
• Controllers

October 2020
Modeling Networks
Nodes
• Electro-Mechanical
• Fans and Compressors
• Fuel Injection
• Gas Turbine Components
• Heat Exchangers
• Junctions
• Losses
• Miscellaneous
• Motors
• Orifices
• Pipes
• Pumps
• Reservoirs
• Solids
• Sources
• Transitions
• Valves
• Weirs
Related Topics
Materials
Aligning Components
Nodes
Nodes are the connection points between components. They can propagate humidity, have
coordinates assigned to them, have levels applied to them, and be used to model auto-
vaporization.
Humidity
In the propagation of humidity in 4-armed components, for each separate stream, humidity is
propagated in the direction of the flow between the two nodes connected by the component.

October 2020
Modeling Networks
Nodes
Humid Air Psychrometrics

In Humid Air Psychrometrics, Specific Humidity is a 'conserved quantity'; it propagates
unchanged through all components, except those that can add or remove moisture (such as the
AC Evaporator and the Water Separator). Combining streams at nodes and junctions, mix
Specific Humidity in proportion to the incoming mass flow rates.
Coordinates
Nodes can have coordinates assigned to them. This is useful when you want to specify the
positions of components in a fluid circuit, which are subject to the body forces acting on them.
A typical example would be the modeling of an aircraft fuel system, where you want to observe
the effects on the flow of fuel as the aircraft banks and turns.
Applying Levels To Nodes

Nodes can be assigned a 'level'. This means that components can be elevated with respect to one
another. Take for example, the network shown below which represents a simple rising main.
Figure 5-1. Nodes - A Simple Rising Main

October 2020
Modeling Networks
Nodes
The nodes in the path have the values set below:

Table 5-1. Nodes - Levels in a Rising Main
Node Level
5 20 m
6 45 m
7 50 m
8 40 m
9 20 m
Node Terminology in Priming Applications

• Dry - Used as a replacement for 'Compressible', when setting the circuit type for a node
• Wet - Used as a replacement for 'Incompressible', when setting the circuit type for a
node
Nodes and Internal Nodes

In circuits, nodes are the connection points between the components comprising the circuit.
Internal nodes are applicable to components such as Pipes, Ducts, Passages, Rotating Passages.
If we take pipes for example, internal nodes longitudinally segment the component for
calculation purposes. Essentially, the pipe is divided into (Number of Internal Nodes + 1) equal
length segments. The process is the same for Ducts, Passages and Rotating Passages.
Figure 5-2. Internal Nodes
Auto-Vaporization
Choked flow is a limiting condition that occurs when the static pressure of the liquid drops
below the vapour pressure. At that point, the liquid will partially flash into bubbles of vapour
and the subsequent collapse of the bubbles cause cavitation. The vapour bubbles occupy more
volume than the same mass of liquid, resulting in restriction of the flow. When fully choked
flow occurs, fluid flow will not increase when the downstream pressure is decreased. Choked
flow results in high noise levels, vibration, pipe stress, and severe erosion and pitting of the
valve seat and disc.

October 2020
Modeling Networks
Nodes
To model the choking of the liquid flow, Adopt a systematic, staged approach to model
development. provides an 'Auto-vaporization' feature for nodes. Vapour cavity formation can
only be modeled at the nodes connected to the component. Therefore, the choking of liquid
flows can only be modeled at the nodes. This can be done by (i) selecting the required node and
(ii) setting the Auto-vaporization property to 'Yes'. When Auto-vaporisation is turned ON for a
node and if cavity is formed at the node (i.e. static pressure at the node decreases below liquid
vapour pressure), then the static pressure of the node is reset to the liquid vapour pressure.
When evaluating cavity formation at an Auto-vaporization node, the static pressure at the node
is calculated from the node total pressure minus the dynamic pressure based on the highest
liquid velocity flowing towards the node. After the cavity is formed, the total pressure at the
node is calculated from the liquid vapour pressure plus the dynamic pressure, again based on the
highest liquid velocity flowing towards the node.Because this algorithm relies on liquid
velocities, the branch area must be known. If branch area cannot be determined, the node total
pressure will be used instead of static pressure and a warning will be issued.
Note
Auto-vaporization can only be used in Incompressible simulations.
Input Parameters
• Circuit Type
Used to set the circuit type for the node. the following types are available:
o Incompressible
o Compressible
o A/C
o Humid Air
o Solid
o Mechanical
o Complex 2-Phase
o Complex Vapour Phase
o Complex Liquid Phase
• Level
Used to set the level of the node.
Default = Not Set
• Temperature

October 2020
Modeling Networks
Materials
Used to set the temperature of the node.

Default = Not Set
• Auto-vapourization
An option used to turn auto-vapourization On or Off.
Default = Not Set
• X, Y and Z coordinates
Used in aerospace applications to set the X, Y and Z coordinates to their required
values.Default = Not Set
Materials
The Simcenter Flomaster database contains a range of materials that can be used in you
networks. You can also create you own custom materials.
Adopt a systematic, staged approach to model development. materials are grouped into the
following categories:
• Air Conditioning - includes a range of refrigerants used in Automotive Air Conditioning

applications, such as R12, R134a, R22, etc.
• Compressible - includes a range of fluids used in Compressible Flow applications, such
as: Air, Carbon, Dioxide, Freon, etc.
• Humid Air
• Incompressible - includes a range of fluids used in Incompressible applications, such as:
Dry Air, Glycol/Water coolant fluids, Kerosene, etc. Also included are a range of fluids
used in Hydraulic Power applications, such as: Anvol, Energol and Tellus liquids.
• Solids - these include Aluminum, Concrete, Copper.
• User-defined - this is reserved for the materials that you define for specific applications.
Adopt a systematic, staged approach to model development. also contains templates that you
can uses as a basis for own materials:
• Standard Gas Template

• Standard Liquid Template
• Standard Solid Template.
Related Topics
Components
Aligning Components

October 2020
Modeling Networks
Accessing Components and Materials
Accessing Components and Materials

Components and materials are available from the Catalogues tab.
• The catalogues available to you depends upon your license type.
Procedure
1. Click on the Catalogues tab to see all the sub-catalogues.
2. Open the and close the folders using the and buttons.

October 2020
Modeling Networks
Building a Network
Building a Network
You build a network by placing and joining components (which are grouped in the Components
Catalogue) on the Network Drawing window.
There is a worked example of creating a simple network in the Simcenter Flomaster Getting
Started Guide.

Switching the Snap To Grid On or Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Adding Components to a Network

Adding components to a network is an essential part of creating a realistic model in
• You must have Network Configurator permission to add components to a network.
Prerequisites
• A network - For details on creating networks see Creating Networks.
Procedure
1. Open a network.
2. Click the Catalogues tab to see all the available catalogues, open the Components
folder and navigate to the folder which contains the component you want to add to the
network (for example Pipes).
3. Drag and drop a component onto the Network Drawing window.
The component is placed on the Network Drawing window as an icon-like image.
4. Repeat steps 2and 3 until you have all the components required to make your network.
Tip
You can use the right-hand mouse button to copy and paste options to add several
components of the same type.
5. To move components drag and drop them to a new position - You can move components
individually or several at the same time by multiply selecting (either by holding the
CTRL key whilst selecting or by using the left-hand mouse button to draw around a
group of components).

October 2020
Modeling Networks
Switching the Snap To Grid On or Off
Note
You can specify whether components are can be placed anywhere in the drawing
window, or use a grid to ensure that they remain aligned by Switching the Snap To
Grid On or Off.
Related Topics
Rotating Components
Aligning Components

You can use the Snap to Grid function to keep components and nodes aligned.
Prerequisites
• You must have Network Configurator permission to move, connect, or copy
components in a network.
Procedure
1. Click the Snap to Grid button (on the Schematic toolbar).
Note
If the Schematic toolbar is not visible, switch it on by checking Schematic from the
View > Toolbars menu.
2. To switch off the Snap to Grid functionality click the Snap to Grid button again.
Related Topics
Rotating Components
Aligning Components
Rotating Components
You can change the orientation components in the network drawing window.

October 2020
Modeling Networks
Aligning Components
Procedure
1. Use the X Mirror, Y Mirror, and Rotate buttons on the Schematic toolbar to rotate
components or groups of components.
Note
If the Schematic toolbar is not visible you can switch it on by checking Schematic
from the View > Toolbars menu.
Table 5-2. Rotating Components

Button or Control Function Action
X Mirror Mirrors a component or group of
components in the X direction.
Y Mirror Mirrors a component or group of
components in the Y direction.
Rotate Rotates a component or a group of
components in a clockwise direction.
2. You can rotate pipe components by dragging and dropping either end of the component.
Related Topics
Aligning Components
Aligning Components
You can align all (or a sub-set) of the components in your networks. This is useful for arranging
large networks containing many components.
• You must have Network Configurator permission to move components in a network.
Prerequisites
Procedure
1. Using the mouse draw a box around the components that you want to align.

October 2020
Modeling Networks
Renumbering Components and Nodes
2. Click the button to align the components horizontally or the button to align the
components vertically.
Note
You should only use this facility when the components are more or less in a straight
line. You can undo the action by selecting Undo from the Edit menu.
Related Topics
Components
Materials
Rotating Components

Components and nodes are automatically numbered in the order that you add or create them but
you can re-number the components and nodes in a network.
Note
The Component and node numbers can be set to visible or hidden (see “Adding Text, Lines
and Boxes to Networks” on page 73).

• You must have Network Configurator permission to renumber components in a
network.
Prerequisites
• A network - For details on creating networks see Creating Networks
Procedure
1. Select Renumber from the Network menu. The cursor changes to a renumber tool icon.
2. To renumber a single Component or node:
a. Click the component or node that you want to renumber. The Renumber dialog box
is displayed.
b. Enter a new number and click OK
3. To renumber a group of components or nodes

October 2020
Modeling Networks
a. Draw a marquee around the group of component and nodes that you want to
renumber.
b. Select Renumber from the right-hand mouse button menu. A Renumber
confirmation dialog box is displayed.
c. Click OK to confirm.
4. To renumber the whole network
a. Click on the background of the network. A Renumber whole network dialog box is
displayed.
b. Click OK to confirm.
5. Switch off the renumber tool by pressing the Esc button.

October 2020
Modeling Networks
Moving Around the Network Drawing window
Moving Around the Network Drawing window

When working with large networks you often need to zoom in to see the detail of a part to the
network. Simcenter Flomaster contains tools which help you to zoom in and out and whilst
retaining a sense of which part of the larger network you are viewing.
Video
Zooming in and Out of the Network Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Zooming in and Out of the Network Window

You can set the magnification of the network (the zoom) and move around the network using
the scroll bars or mouse. You can also reset the zoom, zoom to fit, and display an overview box
which helps you when navigating large networks.
Prerequisites
• Ensure that the Schematic Zoom and View Toolbar is visible.
Procedure
1. Open a network.
2. To zoom in either:
• Use the Zoom dropdown list, , to choose a larger zoom percentage.
• Click the Zoom In button, . The Cursor changes and with each mouse click the
magnification increases.
• Hold the CTRL key and use the mouse scroll wheel.
3. To zoom out use the Zoom dropdown list, , the Zoom Out button, , or the
CTRL key and the mouse scroll wheel.
4. To zoom to fit (where the zoom is set so that the whole network is visible in the network
Drawing window) click the Zoom To Fit button, .
5. To return to the default (100%) zoom click the Normal Zoom button, .

October 2020
Modeling Networks
Using the Network Overview
Tip
When the zoom has been set so that the current network is bigger than the network
drawing window, you can move around the window by either using the horizontal
and vertical scroll bars or by clicking the Pan button, and then using drag and drop to
move the new work view.
Related Topics

You can use the Network Overview window to show an overview of a large network whilst you
are working in detail on a part of that network. You can also use it to easily navigate around
large networks.
Video
Prerequisites
• Ensure that the Schematic Zoom and View Toolbar is visible.
Procedure
1. Open a network
2. Click the Overview Window button, . The Over View window is displayed.
You can move and resize the Overview window and, by using CTRL and the mouse
wheel, you can zoom in and out. The overview window always remains on top of all
other windows.
As you increase the magnification of the Network Drawing window you can see the area
displayed, marked on the Overview window, as a green outline.
3. You can move around the network (pan) by dragging the green outline in the Overview
window.
4. Resizing the green outline in the Overview window will alter the magnification level of
the Network Drawing window.
Related Topics
Zooming in and Out of the Network Window

October 2020
Modeling Networks
Using the Catalogue Palette
Using the Catalogue Palette

The Catalogue Palette is a window which you can use to hold a sub-set of components, this can
make adding components to a network easier. The palette can be positioned and displayed in
several ways.
As you select component catalogues (in the Project View pane) the contents are displayed in
the Catalogue Palette, giving availability to the components even when the Project View pane
is set not to display. Because the Catalogue Palette can be un-docked and positioned in a variety
of places in the Network Drawing window, you always have access to the selected components.
This video demonstates how to use the Palette when adding components to the Network
Drawing window:
Showing the Catalogue Palette

The Catalogue Palette is not visible by default, you must make it visible to use it.
Procedure
1. Select Catalogue Palette from the View menu. The Catalogue Palette is displayed to
the right of the project view pane. The contents of the palette are those of the currently
selected (in the Catalogues tab) component catalogue.
2. To set the palette to auto-hide:
a. Click the pin button, .
The palette is un-pinned and slides to the left of the Project View pane leaving a
small tab with the name of the currently selected component catalogue.
b. To show the palette again click on the tab. The palette remains visible until The
Project View pane is clicked.
c. To return the palette to always displayed, click the un-pin button, .

October 2020
Modeling Networks
Connecting Components
3. To “float” the palette (as a separate window that you can position anywhere):
a. Right-click on the heading of the palette and select Floating from the menu.
The palette is then displayed as a window which you can position and re-size. You
can also re-dock the palette anywhere in the Simcenter Flomaster window by
moving it until a gray box opens (indicating the docked position). To un-dock the
palette again click on the palette title and drag it into the center of the Drawing
window.
4. Set the palette as a tabbed document in the Drawing Window:
a. Right-click on the heading of the palette and select Tabbed Document from the
menu.
The palette is displayed as a tab (similar to multiple networks) along the top of the
Network Drawing window. You can change the position of the tab by selecting
either New Horizontal Tab Group or New Vertical Tab Group from the right-
clickmenu and return the tab to its original position by selecting Move to Previous
Tab Group.
Return the palette to its original (docked position) by:
i. Right click over the palette title and select Close from the menu. The Component
Palette closes.
ii. Select Component Palette from the menu. The Component Palette opens,
docked to the left-hand side of the Network Drawing window.
Connecting Components
You connect components in the Network Drawing window to create fluid paths. Components
have connection points, where they can be joined to other components or nodes.
For more information on Connection Points see Connections and Their Meanings.

• You must have Network Configurator permission to connect components in a network.
Prerequisites
Procedure
1. Point to the first connection point. The cursor changes to:

October 2020
Modeling Networks
Connections and Their Meanings
2. Use the mouse to draw a line to the next connection point. If this is the first connection
that you have created for this network the Circuit Type Precedence order dialog box is
displayed. Set the circuit type precedence order:
a. Select the required connection type and click the Save button to close the dialog box.
Depending on the connection type(s), a node point is automatically inserted.
Note
The connection (e.g. link) between components can be either straight or orthogonal.
To change the connection type right-click on the connection and select either:
Straight or Orthogonal
Connections and Their Meanings

Components are joined via connection points. Connection points are color and shape coded to
aid identification.
Figure 5-3. The Component Connection Types

October 2020
Modeling Networks
Copying Components
Copying Components
You can copy individual or groups of components.
Prerequisites
Note
You can copy groups of components and nodes by selecting the group to be copied (by
using the mouse to draw around the group, or holding the CTRL key whilst multiply
selecting objects) and then following the steps above.
Procedure
1. Right-click the component and select Copy from the menu.
2. Move the cursor to the required position, right-click and select Paste from the menu and
then left click to place the component.
3. Select Idle mode from the right-click menu to escape from the copy mode.
The component, parameters, and any associated text is copied.
Deleting Components and Nodes

You can delete components and groups of components.
• You must have Network Configurator permission to delete components in a network.
Prerequisites
• A network containing at least one component.
Procedure
1. Select the component (or group of components) that you want to delete. A red box is
shown around the component.
2. Press the Delete key. The component (or group) is highlighted red and a confirmation
dialog box is displayed.

October 2020
Modeling Networks
Replacing Components
For Networks that have results the Choices for Preservation of the Audit Trail dialog
box is displayed. You can either:
• Keep the results and automatically create a new child copy of the network to work
on.
The new copy will not have any result sets associated with it and will still contain the
component(s) that you set out to delete in step 1.
• Delete the result sets.
All result sets and the components you specified in step 1 will be deleted
The Component Replacement function enables you to replace every instance of a component in
a collection or the whole network with a new component.
You can replace unwanted components by deleting them and then adding and re-connecting
with a new components. But for large networks, where you may want to replace many
components, this can be very time consuming.

• You must have Network Configurator permission to add and delete components in a
network.
Prerequisites
• A network containing some components.
• To replace a sub-set of components (rather than all components of a specific type in a
network) you must first create a collection which contains the components to be
replaced. For more information on creating collections see “Using the Collection List”
on page 118.
Procedure
1. Choose a component to replace (you only need to select one example of the components
you want to replace, for example to replace all Pipe: Cylindrical Rigid components in a
network, you only need to select one Pipe: Cylindrical Rigid component).
2. Click the button in the Network View pane. The Component Replacement dialog
box is displayed.
3. Specify which components are to be replaced. Select from:
• Replace selected components only - only the single component that you selected in
step 1 will be replaced.

October 2020
Modeling Networks
• Replace all components of the selected type present in the collection box -
Applicable when replacing a sub-set of components as specified in the Prerequisites
section. When selected all components of the type selected in step 1, and in the
current collection, will be replaced.
• Replace all components of the selected type present in the whole network - All
components of the type selected in step 1 will be replaced.
4. Click the Proceed Button.
5. Specify the component to replace with by clicking the Proceed button and then selecting
a suitable replacement by Navigating or Searching the Database.
Note
You can only select components which are compatible/similar to the component you
are replacing.
6. If the network contains results you must specify how to manage the result sets.
Select from:
• To keep the results and automatically create a new copy of the network to work
on - a copy of the network is created. The copy will not have any result sets
associated with it and will still contain the component(s) that you set out to replace.
• Automatically delete the results and continue modifying the current network -
All results are deleted.
• If there are no results associated with the network this section of the Component
Replacement dialog box is unavailable.
7. Click the OK Button.
Results
The component replacement is made. Component connections are retained and where
compatible, the input data form the replaced component is used in the replacement.

October 2020
Modeling Networks
Component Input Parameters
Component Input Parameters

There is a minimum amount of information (Input Parameters) that you must enter, for each
component in a network, before you can run a simulation. The more information and the more
accurate that information is, the more accurate the results of a simulation will be.
The input parameters that are available and those that are mandatory vary for each component
type and the simulation type that you intend to run. For example:
• For the Bend: Circular Mitre component you must enter a value for Diameter.
• For the Bend: Rectangular Mitre component you must enter a values for Breadth and
Width (there is no Diameter input parameter for this component.
• When using the Bend: Circular Mitre component The Deflection Angle Input Parameter
is available (and mandatory) for all simulation types. But the Thermal Capacity is only
used for some of the simulation types.
The Input parameters are color coded to help you to quickly see which are mandatory. See
Tables for more information.
The Simcenter Flomaster Component Reference Manual contains details of all components,
definitions and guidance on input parameters, explanations of results, guidance on the correct
use of each component including any limitations, and provides information on the calculations
that are performed to arrive at the results.
Setting Component Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Setting Component Input Parameters

You must set all the mandatory Input Parameters before running any simulations. Setting values
for optional Input Parameters will increase the accuracy of simulation results.
The Simcenter Flomaster Component Reference Manual contains details of all components
including definitions of the Component Input Parameters.

• You must have Network Configurator permission to edit component input parameters in
a network.
Prerequisites
• A network containing at least one component
• Ensure that the Network View pane is visible
Procedure
1. Set the Mode to Data.

October 2020
Modeling Networks
Using the Collection List
2. If you intend to run a single type of simulation (for example

1. Incompressible Steady State) it is recommended that you specify the simulation
type.
To do this:
a. Select the simulation type from the Simulation Type dropdown list.
If you intend to run several simulation types leave this dropdown list set to
0. All Anaylsis Types.
3. Click on a component in the Network Drawing window. The Input Parameters for the
component are displayed in the Properties Table in the bottom area of the Network View
pane.
Tip
When entering input parameters for the first time or updating several components, it
is recommended that you work systematically in increasing component numbers.
You can set the component numbers to be visible by using the Component Id OFF/ON
button on the Schematic toolbar.
4. Click into a cell to add information or edit the contents. Some cells contain links to sub-
forms, others open further dialog boxes which help you to add input data.
5. Mandatory input parameters (cells colored red) must be completed prior to running a
simulation. If you attempt to run a simulation without all mandatory input parameters
completed Simcenter Flomaster will generate an error.

You can create a collection of a sub-set of the components and nodes in a network. You can use
collections to make changes to, or produce reports on, the components or nodes in a collection.
For example, you could create a collection of some of the cylindrical pipes in a network and
then replace these with rectangular pipes. This would be quicker than deleting, replacing and re-
connecting each pipe individually.
You can also use the collection to move components around the Network Drawing window.
Procedure
1. To create a collection by either:
a. Select multiple components or nodes (or both) and choose Collect... from the right-
hand mouse button menu.
b. Click the Open the component search and collection dialog... button, .
The Component Collection dialog box opens.

October 2020
Modeling Networks
To collect all the nodes of the Network by click the Collect All Nodes button.
To collect all the components of the Network by click the Collect All Components
button.
You can choose specific components or nodes:
If you want to... Do the following:
Specify components or nodes by Specify Before and/or After dates.
date You can use the Between option to use
Before and After clauses.
Search by Component or Node IDs Check the Search by IDs option and enter
IDs (or ranges separated by commas) in the
appropriate field.
Find specific components in the Use the Search by Components tree to
Network navigate to and select the components that
you want to add to the collection.
Add the nodes and components of a Use the Layer dropdown to choose the
specific layer layer that contains the nodes/components
that you want to add.
For more information on Layers see “Layer
Management” on page 123.
Once you have selected at least one component by this method you can filter by
feature:
Use the Search by Component Feature Value tree to specify a feature to filter on.
You can, for example, specify pipes greater than 50 m long by:
o Selecting the Length feature
o Setting the Collection Criteria to Greater Than

October 2020
Modeling Networks
o Setting a Test criteria of 50 m
Click Collect to add your selection to the collection.

2. You can:
If you want to... Do this:

Add further components or nodes to the Double-clicking them in the Network
collection Drawing window.
Sort the collection list Click on any column header to sort by
that type.
Delete items from the collection Select the item that you want to delete
and then click the button.
Clear the collection Click the button.

October 2020
Modeling Networks
3. You can add extra columns to the collection table by right-clicking on one of the column
headers and selecting the required headers. Un-check any that you want to hide.
4. To move components using the collection list:
Note
This is useful for networks where accurate positioning is required. For example,
those derived from a CAD package.
a. Ensure that the X and Y columns are displayed in the collection list (see step 3).
b. By changing the X and Y values, you can move the component in the Network
Drawing window.
Tip
You can cut and paste data into the grid.

October 2020
Modeling Networks
All components are referenced with respect to position 0.0, the top-left corner of the
Network Drawing window.
Note
Use the Pipe End X and Pipe End Y values to move pipe components.

October 2020
Modeling Networks
Layer Management
Layer Management
You can use the Layer Manager to control the display of layers in the Network Drawing
window.
About Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
About Layers
There are two types of layers: Simcenter Flomaster set layers, and user-defined layers.
Simcenter Flomaster Set Layers

The Simcenter Flomaster layers (all of which are active and visible):
• BackgroundLayer - by default, background images are applied to this layer. You can
also use this layer to color a background circuit that links to the main circuit via a
controller.
• TextLayer - this is used for the text that you add to a network to identify specific parts.
• DefaultLayer - this is the top-level view, it comprises all the components in the network.
It is the view you see when you open a network.
• SensorLayer - contains any sensors that you have added to the Network (see “Creating
and Using Network Result Sensors” on page 453)
User-Defined Layers
A user-defined layer is a layer that you can apply groups of components to. For example in a
network containing a number of circuits, such as an AC circuit and a cooling circuit, user-
defined layers could be used to hide one circuit whilst working on the other.
You can create multiple user-defined layers which you can apply components and nodes to.

October 2020
Modeling Networks
About Layers
Layer Definitions
The following table shows the layer definitions and the related actions:
Table 5-3. Definitions
Definition Action
Active Controls where new components are added. If a user-defined layer is
active, then any new components you add are added to this layer.
If all the system layers are active, then any new components are added to
the default layer. An exception to this are text boxes and background
images, which are added to their respective layers.
Locked If the layer is locked, then you cannot:
• Add components to the layer.
• Copy components within the layer. A warning message is displayed if
an attempt is made.
• Delete the layer.
• Move components within the layer
• Add images (Background layer only)
Note: Even though the layer is locked, you can still edit the
components within it.
Rules Governing Layers

The rules governing layers are:
• By default all three Simcenter Flomaster layers are active and visible.
• The default layer and any user-defined layer are mutually exclusive. If you create a layer
and make it active, then the default layer is deactivated. Similarly, if you make the
default layer active, then the user- defined layer is deactivated.
• Only one user-defined layer can be made active at a time.
• The locked and active states are mutually exclusive. If an active layer is locked, it
becomes deactivated, and the other way round. If you attempt to lock all the layers, then
the active state is applied to the remaining unlocked layers, if there is one. This could be
a user-defined layer, if the default layers are all locked. If there is no spare layer, then
the final attempt to lock is ignored. There will always be one active layer and by
extension, one layer that is not locked.
• When a user-defined layer is deleted, then any components in that layer are reassigned
to the Default layer.
• Components can only be copied within their own layer, regardless of whether the layer
is active or not.

October 2020
Modeling Networks
Adding a Circuit to a Layer
Related Topics
The Layer Manager Dialog Box
Using the Layer Manager - Example

You can add a circuit to a layer directly from the Network Drawing window.
Note
The layer has to be one of the default Simcenter Flomaster layers or one that you have
previously defined in the The Layer Manager Dialog Box.
Procedure
1. Use the mouse to draw a box around the group of components.
2. Click the Add to Layer button. The Circuit Layer dialog box is displayed:
3. Select the required layer by clicking its associated checkbox.

4. Click OK.

October 2020
Modeling Networks
Related Topics
About Layers

October 2020
Modeling Networks

To access: Click the button, or right-click and select Open Layer Manager.
The Layer Manager dialog box displays the Simcenter Flomaster and any user-defined layers.
From it you can change layer properties and add and remove user-defined layers.
Figure 5-4. The Layer Manager Dialog Box
Objects
Table 5-4. Layer Manager Dialog Box Contents
Field Description
Number of Components Displays the number of components in a network.
Add Layer Adds a user-defined layer.
Delete Layer Deletes the selected user-defined layer.
Usage Notes
You can use the Layer Manager dialog box to:
• Create user-defined layers.

• Make a layer active or inactive. When a layer is active, any components dragged into the
schematic are assigned to this layer. Layers become inactive when another layer is made
active. For example, if you make a user-defined layer active, then the
Simcenter Flomaster set layers are deactivated.
• Make a layer transparent, hidden, or locked.
• Apply different colors to layers.

October 2020
Modeling Networks
Table 5-5 describes in detail the tasks that you can perform in the Layer Manager dialog box.
Table 5-5. Tasks To Perform in the Layer Manager Dialog Box
Task Action
Add a new layer 1. Click the Add Layer button. The New Layer dialog box is
displayed.
2. Enter the new name and then click OK.
3. Click Apply followed by OK.
The new layer is automatically set to be visible, but not active
Make a layer active 1. By default, all the three Simcenter Flomaster set layers are active.
To set a user-defined layer active, click its check box in the Active
column.
The Simcenter Flomaster set layers are deactivated, but remain
visible.
Delete a layer 1. Select the user-defined layer and then click the Delete button.
Note: If you attempt to delete one of the three Simcenter Flomaster
set layers, then a warning message is displayed.
Set the transparency 1. Select the required layer by right-clicking in the Layer column. The
level of a layer Transparency dialog box is displayed.
2. Set the slide control to the required level and then click OK.
Make a layer visible 1. Select the required layer by right-clicking in the Visible column. A
check mark is displayed indicating that the selected level is now
visible.
Lock a layer 1. Select the required layer by right-clicking in the Lock column. A
check mark is displayed indicating that the selected layer is now
locked.
Note: By default, all the Simcenter Flomaster set layers are locked.
When you do this, the Simcenter Flomaster set layers are
deactivated. Also, if you lock a user-defined layer which is active, then
its active state is passed to the preceding layer.
Apply a colour to a 1. Select the required layer by right-clicking in the Colour column.
layer The Colour dialog box is displayed.
2. Select the required colour and then click Apply followed by OK.
Note: When you do this, any components and nodes that are
assigned to this layer will adopt the selected colour.

October 2020
Modeling Networks
Related Topics
About Layers

This example shows how to create a new layer, assign it a color, and add components to the
layer.
The example is based upon an Automotive Cooling System.
Figure 5-5. Using the Layer Manager - Example Network
Procedure
1. Create the new layer:
a. Using the mouse, draw a box around the group of components to highlight them.
b. Click the button to open the Layer Manager.

October 2020
Modeling Networks
c. Click Add Layer to display the Add Layer dialog box.

d. Enter the name of the new layer, Thermostat, and click OK.
e. Click the color box for the new layer to display the Color dialog box.
f. Select the required color and click OK.
2. Assign the components to the new layer:
a. Click the Add to Layer button. The Circuit Layer dialog box is displayed.
b. Click the required check box and then click OK.

3. Click in the drawing window to see the changes.
Related Topics
About Layers

October 2020
Chapter 6
Simulations
During a simulation Simcenter Flomaster performs a series of calculations to generate results.

Simulations can be steady state (where Simcenter Flomaster calculates the results without
taking time into account) or transient (where changes over a set time period are recorded).
Either type can also take into account heat transfer.
The following simulation types are available:
Note
Your license type may restrict which simulations you can see and run
1. Incompressible Steady State
2. Heat Transfer Steady State
3. Incompressible Transient
4. Heat Transfer Transient
5. Incompressible Restart
6. Incompressible Flow Balancing
7. Incompressible Priming
8. Compressible Steady State
9. Compressible Transient
10. Compressible Flow Balancing
11. Compressible Restart
12. Two Phase Steady State
13. Two Phase Transient
15. Two Phase Steady Restart
Note
There is no 14. Two Phase Flow Balancing simulation type

October 2020
Simulations
Running a Simulation - Overview of the Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Overview of the Simulation Differences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Simulation Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Setting the Convergence & Tolerance Criteria. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Setting the Output Control Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Setting the Fluid Properties Caching Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Running a Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Using Data from Previous Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Resolving Simulation Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Aerospace Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Aerospace Error and Warning Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Turbine Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Running Turbine Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
About Swirl Effects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Swirl Effects - Node Y Coordinate - Data Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Restart Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Considerations for Restart Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Restart with Simulation Time Step Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Geometric Heat Exchanger Wizard - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Geometric Heat Exchanger Wizard - Scripts and Data Structure. . . . . . . . . . . . . . . . . . . . 193
Geometric Heat Exchanger Wizard - Connectivity Examples . . . . . . . . . . . . . . . . . . . . . . 195
Using the Geometric Heat Exchanger Wizard - Creating a Generic Heat Exchanger . . . . 198
Using the Geometric Heat Exchanger Wizard - Creating a Fin and Tube Heat Exchanger 204
Exchanger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Hydraulic Gradient Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Hydraulic Gradient Line - Worked Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Using the Time Step Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

October 2020
Simulations
Running a Simulation - Overview of the Process
Running a Simulation - Overview of the

Process
The process of generating an accurate network which produces meaningful results usually
involves iteratively refining the network over a series of simulations.
Figure 6-1 shows a typical simulation work flow.

October 2020
Simulations
Running a Simulation - Overview of the Process
Figure 6-1. Running a Simulation - Overview
When you run a simulation, pressures and flow rates are calculated throughout the network.

October 2020
Simulations
Overview of the Simulation Differences
Most components have a common set of results (Controllers and Solids are exceptions to this).
For example, for Pipes and Bends in a Steady State simulation, you would expect to see:
• Pressure at connections 1 and 2

• Volumetric flow rate at connections 1 and 2
• Velocity at connections 1 and 2
For example, for a Compressible or a Heat Transfer simulation you would expect to see the
common set of results plus those that were applicable to the simulation type. Each component
outputs a number of Operational Variables (Opvars), which are specific to that component.
How Simulations Work

For each simulation that is run, Simcenter Flomaster carries out a series of pre-processing
checks for network connectivity and completeness of component data. Each type of component
sets up equations to calculate the flow into and out of the component as a function of the
pressures at the ends of the component.
Flow is then eliminated from the equations using continuity at each node. This leaves a set of
simultaneous equations which can then be solved.
The resulting pressures are substituted back into the component equations to calculate new
estimates of the flows. Pressure specifying components impose a pressure at their connecting
node, and their flows are subsequently calculated by continuity from the flows of the other
components connected to that node. This process is repeated until stable values are achieved.

Different simulations types require different methods of approach when reaching a solution.
Heat Transfer Simulations

The temperature boundary conditions are specified by component data flow from the
component into the network. Temperature at the outflow boundaries is calculated by the
simulation
Compressible Flow Simulations

Simcenter Flomaster carries out a 'weak' compressible initialization as a precursor to a full
compressible simulation. The 'weak' compressible treats each component as having
incompressible flow under adiabatic conditions at local density, which varies with pressure and
temperature around the network.

October 2020
Simulations
Transient Simulations
The Compressible Flow solution technique is embedded within a 'time marching' loop which
dictates taht the simulations advance in time using discrete steps. Rates of change of operational
variables are considered from one step to the next. Pipes track pressure wave propagation using
the 'Method of Characteristics', suitably enhanced to account for variations in the velocity of
sound as the pressure changes.

October 2020
Simulations
Simulation Data
Simulation Data
You must set the simulation data before you can run a simulation. Some fields are mandatory;
for these fields you must supply valid data or the simulation will fail. Some items on the data
input form require you to open and complete sub-forms.
Setting the Convergence & Tolerance Criteria. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Setting the Output Control Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Setting the Fluid Properties Caching Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Setting the General Simulation Data

You must set the general simulation data before you can run a simulation.
Prerequisites
Procedure
1. Open the Simulation Data tab (in the to Network Views pane) to display the Simulation
Data form.
Note
The Network Views window is a dockable window on the right of the Network
Drawing window. You can use it to collect components and nodes, set component
and node data, set analysis data and review results. When not required, it can be hidden
from view.
The fields displayed depend on the type of simulation you select. For example for
transient simulations you must enter simulation start and end times and specify a time
step.
2. Enter data in the Value column.
Mandatory fields are colored red, you must enter valid data for these fields of the
simulation will fail.

October 2020
Simulations
Setting the Ambient Conditions
Related Topics
Setting the Convergence & Tolerance Criteria
Setting the Default Material
Setting the Output Control Data
Setting the Fluid Properties Caching Data
Setting the Pipe Profile Data

You can set the ambient conditions data before you run a simulation.
Prerequisites
Procedure
Data form.
2. click the button.
Figure 6-2. The Data Sub Form
The Ambient Conditions sub-form opens.

October 2020
Simulations
3. From this sub-form:
Table 6-1. Ambient Conditions Configuration Options

To Do this
Set the following data items: 1. Click in the adjacent cells and enter the required
• Ambient Temperature values.
• Atmospheric Pressure 2. If your data has different units from those
displayed, then click the associated dropdown
• Acceleration due to Gravity (g) list to select the required units.
• Altitude.
Set the following curves: 1. Click in the adjacent cell to display two buttons.
• Ambient Temperature v Time Click the S... button to display the Selection
From Catalogue dialog box.
• Atmospheric Pressure v Time
The dialog box allows you to search for the
• Altitude v Time required curve. See Searching the Database.
• Ambient Temperature v Altitude
2. Click the D... button to display the curve in a
• Atmospheric Pressure v Altitude plot window.
View the Extended Properties for a 1. Select the data item and then click the Extended
data item Properties button:
4. Click the Return button to close the sub-form and return to the Simulation Data form.
Related Topics

You can set the convergence and tolerance simulation data before you run a simulation.
The Convergence & Tolerance Criteria sub-form shown below is used to adjust the solver
control parameters.
The default values are well suited to general problems. The sub-form is displayed when you
click the Convergence & Tolerance Criteria sub-form button.

October 2020
Simulations
Figure 6-3. The Data Sub Form

Prerequisites
Procedure
Data form.
The Ambient Conditions sub-form opens.

October 2020
Simulations
3. To set a property:
Table 6-2. The Convergence and Tolerance Criteria Form Options

To Do this
• % Pressure Tolerance values.
• % Flow Tolerance
• Weighting Factor
• % Controller Tolerance
• Controller Weighting Factor
• % Temperature Tolerance
• % Enthalpy Tolerance
• Max. Number of Iterations
• % Swirl Tolerance.
Set the following values: 1. Click in the adjacent value cell and enter the
• Min. Pressure Tolerance required value.
• Min. Flow Tolerance 2. To set the units, use the dropdown list to select
the required units.
• Min. Temperature Tolerance
• Min. Enthalpy Tolerance
• Min. Heat Flow Tolerance
• Starting Flow Estimate
• Starting Solid Branch Heat Flow
• Min. Swirl Tolerance
• Min. Swirl Energy Tolerance.
View the extended properties for a 1. Select the data item and then click the Extended
Related Topics

October 2020
Simulations

You can set the default material simulation data before you run a simulation.
Prerequisites
Procedure
Data form.
The Default Material sub-form opens.

3. To set the default material:
Table 6-3. The Default Material Form Options

To Do this
• Gas type - Compressible Click the S... button to display the Selection
simulations only From Catalogue dialog box.
• Solid type The dialog box allows you to search for the
required curve. See Searching the Database.
• Refrigerant Fluid Type - AC
simulations only
• Humid Air Type - AC
simulations only
• Two Phase Fluid Type
Related Topics

October 2020
Simulations

You can set the output control simulation data before you run a simulation.
Prerequisites
Procedure
Data form.
Figure 6-4. The Output Control Sub-Form
The Output Control sub-form opens.

October 2020
Simulations
3. From this sub-form you can perform the following operations:
Table 6-4. The Output Control Sub-Form Options

To Do this
Set the following data items: Click in the adjacent value cell to display a
dropdown list and select the required option.
Set the Component Result Filter Click in the adjacent value cell to display a
option dropdown list and select the required option as
shown below:
Results File Write Interval You can determine the frequency at which results
will be written to the log file. To do this supply an
integer value between 1 and 10.
Note: A higher frequency of write interval can
create a very large log file.
To set a value, click in the adjacent value cell and
enter the required value.
Warnings Suppressed Set to 1 Yes (suppressed) or 2 No (not suppressed).
Note: The output of warning messages slows
down analysis. If you consider that warning
messages are not required for your analysis you
should switch them off. In this instance the total
number of warnings encountered during the analysis
is displayed but no further detail is provided.

October 2020
Simulations
Table 6-4. The Output Control Sub-Form Options (cont.)

To Do this
View the Extended Properties for a Select the data item and then click the Extended
Related Topics

You can set the fluid properties caching simulation data before you run a simulation.
There are two types of fluid air caching:
• Humid Air Caching

• Eagle Database Caching
Prerequisites
Procedure
Data form.
The Fluid Properties Caching sub-form opens.

October 2020
Simulations
3. To set a property:
Table 6-5. Setting the Fluid Properties Caching Data

To Do this
Turn Caching On/Off Click in the adjacent value and enter the required
value using the dropdown list.
Set the following data items: Click in the adjacent value cell and enter the
• Maximum Cache Size required value
• Maximum Humidity
• Maximum Humidity
• Abs. Humidity Tolerance.
Set the following data items: 1. Click in the adjacent value cell and enter the
• Minimum Temperature required value.
• Maximum Temperature 2. To set the units, click the dropdown list which is
displayed and select the required units. For
• Abs. Temperature Tolerance example:
Set the following data items: 1. Click in the adjacent value cell and enter the
• Minimum Pressure required value.
• Maximum Pressure 2. To set the units, click the dropdown list which is
displayed and select the required units.
• Abs. Pressure Tolerance.
Related Topics

You can set the pipe profile simulation data before you run a simulation.

October 2020
Simulations

Prerequisites
Procedure
Data form.
Figure 6-5. The Pipe Profile Data Sub Form
The Pipe Profile sub-form opens.

3. To set the data:
Table 6-6. The Pipe Profile Data Form Options

To Do this
Set the default elevation profile 1. Click in the adjacent cell to display two buttons.
curve: Click the S... button to display the Selection
The dialog box allows you to search for the
required curve. See Searching the Database.
2. Click the D... button to display the curve in a
plot window.
Set the Nominal Pipe Node Click in the adjacent cell and enter the required
Separation Distance value.
Related Topics

October 2020
Simulations
Running a Simulation
Running a Simulation
Once you have supplied all of the mandatory simulation and component data can run the
simulation.
Prerequisites
• You have specified all the mandatory simulation data - For details see Simulation Data
Procedure
1. Click button to start the simulation.
The simulation begins. Progress is displayed in the bottom, right-hand pane. Any
warnings and error messages will also be displayed here.
2. You can pause the simulation at any time by selecting the Pause check box.
Results
• Simulation Messages
As the simulation progresses, a series of messages are displayed. If the simulation is
successful a corresponding message is displayed. To view messages at any time, click
the Messages button.
Using Data from Previous Simulations

You to use data from previous simulations as 'live' data.
You can:
• Take an old component data set where the data has changed for a single component and
use that as live data.
• Take and old result set where the data has changed for all the components and use that as
live date for the entire network.

October 2020
Simulations
Using Data from Previous Simulations
Considering the simple network shown below:
For component 1, the current 'Live' data settings for the AC Condenser are:
You can either:
• Change the highlighted data back to its original settings, and use those settings as live
data.
• Use older network data as Live data.

October 2020
Simulations
Resolving Simulation Failures
Procedure
1. Use the Live data dropdown list to select the simulation that you want to use as the live
data.
2. To set the data live click .
3. Click the Result Sets/Audit tab to see all the results set.
4. Right-click on the required set and choose the Set this simulation input data live
option.
Results
When you run a simulation the data selected above will be used as the live data.

Simulation failures can be resolved with a systematic approach.
Common reasons for simulation failure are:
• Convergence and Tolerance parameters not set correctly.

• Unrealistic flow rates and/or pressures.
• Component data and/or node data not set correctly. The simulation may run, but fail to
converge due to non-physical or unrealistic settings.
• The Simulation Data settings (e.g. Ambient Data, Default Fluid type, etc) incorrectly
set.
When an simulation fails, a failure message is displayed:
Figure 6-6. Simulation Failure Message

October 2020
Simulations
Procedure
1. Review the Errors and Warnings.
2. Check the convergence and tolerance settings and ensure that they are realistic for the
type of simulation you are running.
3. Review and, if necessary, edit the network and/or component data.
4. Review and, if necessary edit, the simulation data settings.
5. For AC simulations ensure that the AC Solution Criteria settings are realistic.
6. Re-run the simulation.The pre-processor will then check that:
a. You have a valid network (e.g. no missing components, unspecified boundary
conditions).
a. You have specified sufficient component data to perform the simulation selected.
If errors are found from either check the simulation will not proceed and an error
message will be displayed. Also messages will be output to the Errors and Warnings
reports.
At this point, you should:
o Review the reports to determine where the error has occurred.
o Make the necessary changes as described in the Errors and Warnings reports.

October 2020
Simulations
Aerospace Simulations
Aerospace Simulations
You can use aerospace simulations to model the mechanisms and phenomena that affect an
aircraft in motion.
You can select either a specific case or specify your own combination of Altitude, Attitude
(Roll, Pitch & Yaw) and Acceleration (in the x, y and z directions).
Some properties only have a significant effect on circuits that operate at relatively low pressure
and contain a relatively dense fluid such as fuel or water. Most power hydraulic systems, such
as flight control, landing gear, etc are influenced to a lesser degree by altitude and hardly at all
by attitude or acceleration. Circuits containing gases, such as ECS or de-icing systems are
mainly influenced by altitude and not by attitude or acceleration, though these might affect
individual components within these circuits (e.g. a Water Separator).
Simcenter Flomaster contains tools to help model phenomena such as Fluid Mixing and
Separation, Psychrometrics and also range of aerospace-specific components. These are
initiated by the choice of network components and circuit type and do not require special
Simulation Data, except for Fluid Mixing, which can be turned on and off by the Fluid Mixing
option on the Simulation tab. See Simulation Data.
You can either specify Atmospheric Pressure and Ambient Temperature directly, or they may
specify Altitude and use curves of Pressure and Temperature v Altitude (Such as the ISA model
defined by ICAO). This data is set on the Ambient Conditions sub-form. See Setting the
Ambient Conditions.
For circuits that are influenced by body forces, you must define their topography using the 3D
Coordinate system and specify either flight data or the instantaneous accelerations in the
Aircraft Data sub-form.

Aerospace Error and Warning Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
What Simulations Can be Run?

The Incompressible Steady State license provides access to two specific incompressible
simulation types.
• Incompressible Steady State simulations
• Incompressible Steady State simulations with Heat Transfer.
Related Topics
Running Aerospace Simulations

October 2020
Simulations
Aerospace Error and Warning Messages

Additional to the general simulation data, for aerospace simulations you must also provide 3D
Node coordinate data and data relevant to the aircraft (such as roll, pitch, and yaw).
For general simulation data see Simulation Data

Prerequisites
• You must have a license which permits aerospace simulations.
Procedure
Data form.
2. Ensure that the general simulation data is set correctly - See Simulation Data
3. Click the button in the 3D Node field.
The 3D Node sub-form opens.

4. Set the X, Y, and Z coordinate data.
Figure 6-7. The Node Data Form
6. Click the button in the Aircraft Data field.

October 2020
Simulations
Figure 6-8. The Aircraft Data Sub Form
The Aircraft Data sub-form opens.

7. From this sub-form you can:
Table 6-7. Setting the Aircraft Data Form Options

To Do this
• Ground Speed. values.
• Turn Radius, and Inclinometer 2. If your data has different units from those
Reading Roll displayed, then click the associated dropdown
list to select the required units.
• Pitch
• Yaw
• Longitudinal Acceleration
• Transverse Acceleration
• Normal Acceleration
Set the following sub-form data: 1. Click in the adjacent cell to display a button.
• Position of Centre of Rotation 2. Click the button to display the sub-form and
enter the required values for the X, Y and Z
coordinates.
9. Click the button in the Aircraft Data field.

October 2020
Simulations
Figure 6-9. The Aircraft Data Sub Form
The Aircraft Data sub-form opens.

Results
• You can now run the simulation.
Related Topics

During an aerospace simulation, a number of error halt and warning messages can occur if the
data is not set correctly or if certain conditions are not met.
Table 6-8 shows the error messages and Table 6-9 shows the warning messages:
Table 6-8. Run-Time Error Halt Messages
Error Message Cause
Roll angle is not set for Aircraft No roll angle data has been set.
Simulation
X Co-ordinate is not set for Aircraft No X, Y, or Z Co-ordinate has been set.
Simulation
Y Co-ordinate is not set for Aircraft
Simulation
Z Co-ordinate is not set for Aircraft
Simulation

October 2020
Simulations
Table 6-9. Run-Time Warning Messages

Warning Message Cause
Ground Speed and Inclinometer reading are No Turn Radius has been set. Make sure a
ignored unless Turn Radius is set suitable value is entered.
Ground Speed reading is ignored unless
Turn Radius is set
Turn Radius and Inclinometer reading are No Ground Speed has been set. Make sure a
ignored unless Ground Speed is set suitable value is entered.
Turn Radius is ignored unless Ground
Speed is set
Inclinometer reading is ignored unless No Ground Speed and Turn Radius has
Ground Speed and Turn Radius are both set been set. Make sure suitable values are
entered.
User-defined accelerations are ignored These are the Longitudinal, Transverse, and
Normal Accelerations that are set on the
Aircraft Data sub-form.
If you have set these, then make sure that
the X, Y and Z coordinate settings are set to
NOTSET
Inclinometer reading overrides Roll setting Inclinometer reading and Roll cannot both
be set. Make sure that the Roll setting is set
to NOTSET.
Related Topics

October 2020
Simulations
Turbine Simulations
Turbine Simulations
Turbine simulation functionality is designed for users who want to model the mechanisms and
phenomena that occur in gas turbines.
Cases of interest include the ability to:
• Calculate and track the effects of swirl throughout a gas turbine system.
• Model the passages between sets of rotating disks and how flow through the passage is
affected due to the geometry of the passage.
• Model the effects of flow through a labyrinth seal.
• Model the effects of flow through passages of varying geometry, and through passages
where either the inner wall, or the outer wall is rotating.
Simcenter Flomaster provides tools to define swirl as Tangential Velocity or as a Swirl Ratio
for specific components, such as boundary components. It also allows friction to be defined as
Variable Friction, for components such as the two Rotating Annular Passages.
Options are provided where the Vortex Type can be defined for components such as the
Labyrinth Seal, and the modeling of multiple flow paths through the use of the Discrete Loss
with Pattern capability.
For components, such as Labyrinth Seals, Rotating Cavities, Rotating Passages where swirl
effects are modeled, Simcenter Flomaster provides a facility whereby you can set a 'Secondary
Air Simulation Enabled' option and other options relating to turbine simulations.
You can set the following parameters:
• Reference Engine Speed

• Swirl Ratio
• Rotational Speed (1, 2, and 3)
• Inpingement Loss Calculation Enabled
By either:
• Setting the individual values from the Turbine Data form (on the Simulation Data tab in
the Network Views Pane)
• Adding a Gas Turbine Model component to the network and then either:
o Setting individual values in the component’s input parameters
o Attaching controllers to the SI connections and using those to vary the input
parameters over time

October 2020
Simulations
Gas Turbine Simulation Types

Running Turbine Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
About Swirl Effects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Swirl Effects - Node Y Coordinate - Data Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

There are several license options which dictate which gas turbine simulation types you can run.
Gas Turbine licenses will allow you to run:
• Gas Turbine Secondary Air - Steady State or Transient simulations

• Gas Turbine Basic - Steady State or Transient simulations
• Gas Turbine Advanced - Steady State or Transient simulations
• Gas Turbine Systems Suite 1 - Steady State or Transient simulations
If you have purchased either a Gas Turbine Secondary Air - Steady State or Transient license,
then you can use the components in the Secondary Air catalogue (such as Rotating Cavities and
Labyrinth Seals).
If you have purchased a Gas Turbine Systems Suite 1 - Transient license, then you can access
all the relevant gas turbine components and be able to run Steady State or Transient simulations,
including Secondary Air simulations.
Related Topics
Running Turbine Simulations

Additional to the general simulation data, for gas turbine simulations you must also provide
turbine information such as (turbine rotation speed,) Y coordinate node data (so that swirl can
be calculated) and details of the ambient conditions.
For general simulation data see Simulation Data

October 2020
Simulations
Note
Reference Engine Speed, Swirl Ratio, Rotational Speed (1, 2, and 3), and Inpingement Loss
Calculation Enabled can be set by either (both methods are described in this topic):
• Setting the individual values from the Turbine Data form (on the Simulation Data tab in
the Network Views Pane)
• Adding a Gas Turbine Model component to the network

Prerequisites
• You must have a license which permits gas turbine simulations.
Procedure
1. Open the Simulation Data tab (in the Network Views pane) to display the Simulation
Data form.
3. For each node in the network ensure that the Y coordinates are set.
Figure 6-10. The Y Coordinate Node Data Form
4. Either:
a. From the Simulation Data form, click the button in the Turbine Data field.
The Turbine Data sub-form opens.

b. Add a Gas Turbine Model component to the network and select it to display the
input parameters in the Network View pane.

October 2020
Simulations
5. Specify the Turbine data:
Table 6-10. Setting the Turbine Data

Set the Secondary Air Simulation 1. Click in the adjacent value cell to display a
Enabled option: dropdown list.
Note: This option must be set to 2. Click the dropdown list and select the required
Yes to run a Secondary Air option.
Simulation. Note: This option is set automatically if a Gas
Turbine Model component is added to the
network (as in Step b).
• Reference Engine Speed values.
• Swirl Ratio 2. If your data has different units from those
• Rotational Speed 1, 2 or 3 list menus to select the required units.
Model impingement losses. Set the Impingement Loss Calculation Enabled field
to Yes.
For more information on Impingement Losses in
Simcenter Flomaster see “Velocity Vectors and
Impingement Losses” on page 167.
7. Click the button in the Ambient Data field.
Figure 6-11. The Ambient Conditions Data Sub Form
The Ambient Data sub-form opens.

October 2020
Simulations
About Swirl Effects
8. From this sub-form you can perform the following operations:
Table 6-11. Setting the Ambient Data Form Options

• Ambient Temperature values.
• Atmospheric Pressure 2. If your data has different units from those
• Acceleration due to Gravity (g) list to select the required units.
• Altitude
• Ambient Temperature v Time Click the S... button to display the Selection
From here you can search for the required curve.
• Altitude v Time
2. Once you have selected the curve, click the D...
button to display the curve in a plot window.
• Atmospheric Pressure v Altitude.
Results
• You can then run the simulation.
Related Topics
About Swirl Effects

Swirl is a phenomenon where vortices are formed in the air flow of rotating machinery, such as
in Gas Turbines. The vortices are caused by the frictional interactions between the fluid and the
rotating components. The vortices can have a marked effect on the pressure drop, temperature
and mass flow through the system. Also, the effects of these vortices are propagated through the
system and can be either enhanced or degraded by other downstream components.

October 2020
Simulations
About Swirl Effects
Swirl represents the portion of the kinetic energy that is attributed to the tangential velocity of
the air flow. It is defined as:
(6-1)
Where:
PT = Total pressure
PS = Static pressure
ρ = Fluid density
u = Radial velocity
v = Tangential velocity
w = Axial velocity
The Tangential Velocity contribution can be accounted in the calculations by the addition of the
'Angular Momentum' balance component in the Simcenter Flomaster solver. The equation for
defining the Angular Momentum is:
(6-2)
Where:
D = Vt*r
Di = Swirl of the fluid
mi = Mass flow component of the fluid
Vt = Tangential velocity component
r = Radius at which the tangential velocity component is defined

October 2020
Simulations
About Swirl Effects
Vortices
There are three types of vortices that can occur in gas turbine systems
• Free Vortex - this is a vortex that is not mechanically driven (irrotational). It occurs
between sets of stationary disks where rotational flow has been introduced into the
chamber. It can also occur when rotational flow is introduced between two disks rotating
at the same speed. In this case there is no external work performed. Any reduction in the
tangential velocity is converted from kinetic energy to potential energy in the form of a
static pressure.
(6-3)
• Forced Vortex - this is a vortex that is driven by a rotating disk. It can occur with a
single rotating disk, with multiple rotating disks, or with counter rotating disks. In each
case, work is done on the system and as such there can be an increase or a decrease in
the tangential velocity, depending on the direction of the flow. This results in pressure
and temperature changes within the system.
(6-4)
• General Vortex - this uses the concept of a 'linear vortex' as a semi-empirical hybrid of
the Free and Fixed vortices to represent swirl in real systems, where the distinction
between Free and Fixed vortices is less clear. Equation 5 shows the how swirl is
calculated for a general vortex.
R1, R2 = Inlet and outlet branch radii - the branch radius is the Y-coordinate of the
corresponding node
Vt1, Vt2 = Tangential velocity at the inlet and outlet branches
n = Vortex constant
For a:
Forced Vortex: n = 1

October 2020
Simulations
Swirl Effects - Node Y Coordinate - Data Handling
Free Vortex: n = -1
General Vortex: < -1 < n < 1
Swirl Effect Components

• Rotating Cavity - Can generate a Forced, Free or General vortex. ΔD is calculated in the
component.
• 2-Arm Cell Component - Rotating Cavities comprise one or more cell components. The
component updates the outlet branch swirl by balancing the angular momentum of the
Rotating Cell.
• Labyrinth Seal - Can generate a Forced, Free or General vortex. ΔD is calculated in the
component.
• Source: Flow with Swirl* - Can be used to model a flow source that exhibits swirl at the
input to another component, which is then propagated through the network.
• Source: Pressure with Swirl* - Can be used to model a pressure source that exhibits
swirl at the input to another component, which is then propagated through the network.
*For both these components, the Swirl can be set on the Swirl Data sub-form by setting either
the Tangential Velocity or the Swirl Ratio.
If the Tangential Velocity is set, then the Swirl = Tangential Velocity*Branch1 Radius.
If the Swirl Ratio is set together with the Reference Engine Speed, then the Swirl = (Swirl
Ratio*Reference Engine Speed)*Branch1 Radius*Branch1 Radius.
The Branch1 Radius is equal to the 'Y' coordinate of the attached node. Swirl is propagated
through the network when the mass flow is positive.

For Swirl calculations, the radius of rotation is required. It is assumed the (0, 0) coordinate is
always center of the compressor in the turbine. As, such 'Y' = 0 and is the center of rotation. All
the node 'Y' coordinates are specified with respect to the axis of rotation. This means that the 'Y'
coordinate of the relevant node will be the radius of rotation for the component branch attached
to this node.
As such, the node radius can never be negative. If a negative value is entered or it is NOTSET,
then the simulation will error halt and an error message will be generated, IF the subsystem
involved is participating in a swirl propagating simulation. If a Secondary Air simulation is to
be carried out, then all the nodes relevant to swirl components must be set accordingly.

October 2020
Simulations
Node Mapping
If you use a cavity component in a network and right-click on the component and then select the
'Edit' option, you expose the network for the cavity itself. This is called the 'Secondary Network
Window'. For the top-level network window to recognize the nodes in the secondary window,
then they have to mapped to the top-level network.
The process is:
1. The arm face with the lowest 'Y' coordinate is determined.

2. The external node connected to this face acts as the reference point for mapping the
nodes in the secondary window nodes to the top-level network nodes.
3. The offset for the secondary network window node is then calculated and the 'Y'
coordinates are then reset.
Consider the figure below which is a combination of a top-level network containing a cavity and
the secondary network window showing the cavity network. The cavity comprises two cell
components.

October 2020
Simulations
Figure 6-12. Swirl Effects - Combined View of Top-level Network and Cavity
Network
The pressure source is connected to Node 1, which in turn is connected to arm 1 of the cavity.
This connection corresponds to connection 1 on the cavity network. As such, face AB is the face
with the lowest 'Y' coordinate and Node 1 becomes the reference for mapping the cavity nodes.
So, the 'Y' coordinate of Node 1 on the cavity = 'Y' coordinate of Node 1 + the offset.
Where:
Offset = Node 1 'Y' coordinate - 'Y' coordinate of Face AB.

October 2020
Simulations
Velocity Vectors and Impingement Losses

Within a gas turbine secondary air systems, there are often 'free air streams' that combine at
different angles, such that vector sums become important. Gas turbines often contain
components, such as guide vanes, designed to maximize the efficiency of the flow by matching
the velocity angles.
It is important to understand the additive and subtractive effects of combining flows with
differing orientations. The vector sums themselves can be calculated by using vector addition:
Figure 6-13. Velocity Vectors - Vector Addition
The effects of individual velocity vectors have differing effects on the system depending on the
design of the cavity they are flowing into. It is important to understand and take into account:
• The portion of the velocity that is not attributed to the main direction of flow or
impingement losses
• Situations where the flow is into a large chamber and all the momentum is lost.
Several scenarios exist, such as flow taking place across two rotating or stationary disks,
flow taking place into a chamber causing all of its momentum to be lost. Typical of these
is the example shown below on which the Simcenter Flomaster impingement
calculations are based.

October 2020
Simulations
Figure 6-14. Velocity - Stationary or rotating Disks
In this example, all the momentum from the hole is lost and converted into total
pressure.
Impingement Loss Components:
• Cell 2 Arm
• Discrete Loss with Patterns
• Cd Discrete Loss
• Compressible Annular Rotating Passage
• Compressible Rotating Passage
• Rotating Orifices (Short and Long)
• Brush Seal
• Labyrinth Seals
• Gas Turbine Model
Of these components, the following output velocity as a result:
• Cell 2 Arm

October 2020
Simulations
• Compressible Rotating Passage

• Rotating Orifices (Short and Long)
• Discrete Loss with Patterns
Turbine Simulations - Velocity Vector Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Turbine Simulations - Impingement Losses Calculations . . . . . . . . . . . . . . . . . . . . . . . . 175
Turbine Simulations - Velocity Vector Calculations

Simcenter Flomaster Velocity Vector Calculations.
Referring to Figure 6-15, consider the following velocity vector making

angles α, β, and with the X, Y and Z-Axis respectively:
Figure 6-15. Velocity Vectors

October 2020
Simulations
then the 'Directional Cosines' for these angles can be evaluated as:
(6-5)
Where:
It is assumed that the component is straight. As is 'Normal Velocity' (flow velocity normal
to the cross-sectional plane of the component), then acts along the line of the component.
Thus, the directional angles of vector will be the same as those for the component.
So, the directional angles can be determined from the orientation of the component in Cartesian
space. For a component with the upstream and downstream node positions having the
coordinates X1, Y1, Z1 and X2, Y2, Z2 respectively, the directional cosines are evaluated as
follows:
(6-6)
Where:
(6-7)

October 2020
Simulations
The directional cosines are determined from Equations 6-6 and 6-7. The components of vector
can then be evaluated from Equation 6-5 as:
(6-8)
For a rotating component, the rotational velocity will import a linear velocity to the fluid.
This linear velocity will always act in the Y-Z plane as shown below:
If we consider a component rotating with rotational velocity about the X-Axis with one of its
nodes at a radius, r, then the vector is the normal flow velocity and is the linear velocity
which is defined as follows:
(6-9)

October 2020
Simulations
Where:
= Position of vector from x-axis, at point P (see Equation 6-8)
= Rotation vector around x-axis. Its direction is along the x-axis
The flow velocity will be the resultant of these two velocities in magnitude and direction. The
axial, radial and tangential components of the flow velocity will be the components of the
resultant velocity , which is defined as follows:
(6-10)
If we take 6-8, then is evaluated as follows:
(6-11)

October 2020
Simulations
and
(6-12)
The linear velocity only acts in the Y-Z plane; hence its X component will always be zero.
Again referring to 6-8, if the position of the node is P (x, y, z) then
From this we have:
The components of the linear velocity can then be defined as follows:
(6-13)
If we take Equations 6-8, 6-10 and 6-13, then we can evaluate the resultant velocity as follows:
(6-14)
Finally, the components of the flow velocity can be evaluated as follows:
(6-15)
From Equation 6-8, we get the velocity component Vx, Vy and Vz. Vy is not necessarily the
radial velocity, as Vz is not necessarily the tangential velocity. The radial and tangential
velocities given in the equation are only correct when θ = 0.

October 2020
Simulations
To evaluate the radial and tangential velocities from Vx, Vy and Vz, it is necessary to perform a
transformation from Cartesian coordinates to Polar coordinates. Using Figure 6-8 shown below,
the two unknown velocities are the radial and tangential velocities Vrand Vt.
From the relationships between the radial and tangential velocities, and Vy and Vz, we get:
(6-16)
and
(6-17)

October 2020
Simulations
Where:
By combining Equations 6-15, 6-16 and 6-17, then the axial, radial and tangential velocities can
be solved, as shown below:
(6-18)
Turbine Simulations - Impingement Losses Calculations

Simcenter Flomaster Impingement Loss Calculations.
Impingement loss modeling is based on the assumption that the kinetic energy related to the
normal component, is entirely lost while the fluid flows from component C1 to C2.

October 2020
Simulations
Figure 6-16. Impingement Loss Calculations
Referring to Figure 6-19 the kinetic energy loss for component C1 can be evaluated as follows:
(6-19)
The normal velocity component is defined as follows:
(6-20)
Where:
Ae = Exit arm cross-sectional area of component C1
ρe = Outlet branch fluid density for component C1

October 2020
Simulations
ṁe = Outlet branch mass flow rate for component C1
If we substitute Equation 6-20 into 6-19, then:
(6-21)
The extra loss coefficient due to impingement is evaluated as follows:
(6-22)
The angle between component C1 and C2 is then evaluated as follows:
(6-23)
Referring to the figure below, the treatment of the problem associated with multi-to-multi
components is best explained as follows. The impingement loss due to changes in the direction

October 2020
Simulations
of flow, from an upstream component Ci, up (i = 1, 2, 3,..., nup) to a downstream component

Cj, dn (j = 1 2, 3,..., ndn), is calculated from the angle through which the direction changes.
Where:
(6-24)
The impingement loss for each upstream component is defined as:
(6-25)

October 2020
Simulations
Where:
(6-26)
The loss coefficient is added to the component flow loss coefficient, to account for the
additional pressure loss.

October 2020
Simulations
Restart Simulations
Restart Simulations
The restart facility allows the simulation data that exists for a particular point in time, to be
stored in a restart file for later use. This enables you to run several simulations from the time
step at which the data was stored (to study for example the effect of different valve closure
rates).
The restarted simulation can continue beyond the time of the original run, and for some
components, some of the data can be changed to allow comparative simulations to be
performed.
When you save data to the restart file, you should be aware that any data saved from a previous
restart will be lost.
The restart facility is applicable to the following simulations:
• Incompressible Transient simulations, with or without heat transfer.

• Compressible Flow Transient simulations.
Considerations for Restart Simulations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Restart with Simulation Time Step Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Considerations for Restart Simulations

There are some points specific to restart simulations that you should consider before running
simulations of this type.
Restart With No Time Step Change

When running a restart simulation without changing the time step, the solution should be
consistent with the original transient run. However, in some situations, the restart solution may
not be exactly the same as the transient solution.
Take for example the following case, where in the original run for a pipe, L/aDt is not an exact
integer, but an integer with ±%. In this case, the characteristic line will not pass through the
nodal points. The Restart simulation then uses interpolation in the Method of Characteristics
(MOC). In this situation, the restart solution will not be exactly the same as the transient
solution, but the results will be close assuming there is a large enough number of internal nodes.
For Compressible Transient, Simcenter Flomaster will calculate the maximum allowed time
step based on the fact that a minimum of two internal nodes should be used for each elastic pipe.
Therefore, If the initial time step is considered by Simcenter Flomaster to be too large when

October 2020
Simulations
running a transient simulation, then it may not be possible to run a restart simulation using a
constant time step.
Restart With Time Step Change

When running restart simulations using a modified time step, the results produced will be
consistent with the original transient run assuming the solution is not time step dependent.
For example, if the original transient (ST) result was produced with a time step of 0.2 seconds,
then the restart result (SR) will be different if using a much larger time step i.e. 2 seconds. In
this case a second transient (ST) would be required using 2 seconds for time step. Then a
comparison of the second ST and the SR should show good results. Therefore, the solution in
this case is time step dependent.
As it is not easy to judge beforehand whether or not a solution is time step independent, it is
recommended that you adopt the following approach:
1. Run a transient simulation with Δt1

2. Run a restart simulation with Δt2
3. Compare the two solutions. If they are close, then the restart solution is reasonable.
Otherwise:
4. Re-run a transient simulation with Δt2 and compare the output with the restart solution.
The restart solution using Δt2 should be consistent with the output from the transient
rerun.
Note
The use of modified time steps in networks which have elastic pipes or simulations with fast
transients is not recommended.
Saving a Simulation Time

You can save simulation time by increasing the time step with no loss of simulation accuracy.
You can also reduce the time step to obtain more details for a fast changing event.
Elastic Pipes
All elastic pipes will be treated as elastic pipes during a restart simulation. Simcenter Flomaster
calculates the maximum possible number of time steps, based on the length of the shortest pipe
and its wave speed.
When running a Compressible restart simulation, Simcenter Flomaster calculates the maximum
number of time steps based on the fact that the default number of internal nodes has been set for
each elastic pipe.

October 2020
Simulations
Restart with No Time Step Change
Non Elastic Pipes

For networks containing non-elastic pipes, the minimum value of time step allowed during a
restart simulation is 0.5 times the original time step value. The maximum allowed value is 10
times the original value.
Related Topics
Restart with Simulation Time Step Change

When running a restart simulation without changing the time step, the solution should be
consistent (although sometimes not identical) with the original transient run.
Take for example the following case, where in the original run for a pipe, L/aDt is not an exact
integer, but an integer with ±%. In this case, the characteristic line will not pass through the
nodal points. The Restart simulation then uses interpolation in the Method of Characteristics
(MOC). In this situation, the restart solution will not be exactly the same as the transient
solution, but the results will be close assuming there is a large enough number of internal nodes.
For Compressible Transient, Simcenter Flomaster will calculate the maximum allowed time
step based on the fact that a minimum of two internal nodes should be used for each elastic pipe.
Therefore, If the initial time step is considered by Simcenter Flomaster to be too large when
running a transient simulation, then it may not be possible to run a restart simulation using a
constant time step.
Related Topics

When running restart simulations using a modified time step, the results produced will be
consistent with the original transient run assuming the solution is not time step dependent.
For example, if the original transient (ST) result was produced with a time step of 0.2 seconds,
then the restart result (SR) will be different if using a much larger time step i.e. 2 seconds. In
this case a second transient (ST) would be required using 2 seconds for time step. Then a
comparison of the second ST and the SR should show good results. Therefore, the solution in
this case is time step dependent.

October 2020
Simulations
As it is not easy to judge beforehand whether or not a solution is time step independent, it is
recommended that you adopt the following approach:
1. Run a transient simulation with Δt1
2. Run a restart simulation with Δt2
3. Compare the two solutions. If they are close, then the restart solution is reasonable.
Otherwise:
4. Re-run a transient simulation with Δt2 and compare the output with the restart solution.
The restart solution using Δt2 should be consistent with the output from the transient
rerun.
Note
The use of modified time steps in networks which have elastic pipes, and
simulations with fast transients is not recommended.
Related Topics

October 2020
Simulations
Creating a Restart File

Restart simulations are transient simulations where you can restart the simulation from a
specific within the timeline. To run a restart simulation you must have created a restart file.
There are three types or restart files that you can create:
• Random time restart files - you can have up to five random files
• Sequential restart files - you can have up to 50 sequential files
• Serialized restart files
Note
You can have a combination of random and sequential files for one transient simulation.
Creating a Random Time Restart File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Creating a Sequential Time Restart File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Serialized Restart File Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Running a Restart Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Creating a Random Time Restart File

Random restart files are one of the file types that you can use in restart simulations. You can
specify up to five time points which will run in the order that you create them.
• You must have a user permission which enables you to run simulations.
Prerequisites
• A transient network - For details on creating networks see Creating Networks.
• You must have a license which permits restart simulations.
Procedure
Data form.
3. Click the button in the Restart Data field.

October 2020
Simulations
Figure 6-17. Creating a Random Time Restart File - The Restart Data Sub Form
The Restart Data sub-form opens.

4. Enter times by clicking in the Value cell next to the appropriate Random restart time.
Note
The restart time must be smaller than the simulation end time.
Creating a Sequential Time Restart File

Sequential restart files are one of the file types that you can use in restart simulations. In these
files you specify a constant interval between two successive restart files.
Prerequisites
Procedure
Data form.
3. Select a simulation type from the Simulation Type dropdown list.
• Select Incompressible Transient for non-heat transfer simulations
• Select Heat Transfer Transient for heat transfer simulations

October 2020
Simulations
4. Click the button in the Restart Data field.
Figure 6-18. Creating a Sequential Time Restart File - The Restart Data Sub
Form
The Restart Data sub-form opens.

5. Set the data items as shown below:
Table 6-12. Creating a Sequential Time restart File Data Form Options
To Do this
Set the simulation to restart at Select Yes from the Restart at frequent intervals?
frequent intervals dropdown list.
Set the number of required restart Click in the adjacent value cell and enter the
files required value.
Set the time to write to the 1st restart
file
Set restart file write time interval
Serialized Restart File Example

Serialized restart files are one of the file types that you can use in restart simulations. A
serialized file is one where a restart file is created after the simulation has started, and after a
given elapsed time.
For example, if you set the Write Time Delay option to 10s, then after Δt seconds of the
simulation the restart file is 'serialized'.
In the figure below, the simulation starts and after a delay of 10s a restart file is created.
Simulation resumes again from the end of the first time period, runs for another 10s and then
outputs another restart file, and so on.

October 2020
Simulations
Figure 6-19. Example Serialized Restart File
Running a Restart Simulation

Once you have supplied all of the mandatory simulation and component data and specified the
details of the restart file(s) you can run a restart simulation.
Prerequisites
Procedure
1. Select Incompressible Restart from the Simulation Type dropdown list in the Simulation
data table.
2. Click button to start the simulation.
The Restart Selection dialog box is displayed.

October 2020
Simulations
Figure 6-20. Restart Selection Dialog Box
3. Select the required restart file and click OK to run the simulation.

October 2020
Simulations
Geometric Heat Exchanger Wizard - Overview

The wizard is a graphical tool that enables you to define the tube connectivity for AC Cross-
flow Heat Exchangers, AC Heat Exchangers, and Heat Exchanger: Cross Flow components.
Due to their complex construction, it is important that when modeling their behavior that the
tube connectivity is correctly defined.
You can model the following types of heat exchanger:
• Generic - With this option you define the number of tube bundles and tube rows that will
make-up the component.
Use this option for all cross flow heat exchangers with parallel tubes and header tanks.
• Fin and Tube- With this option you define the:
o Number of tubes per row
o Number of tube rows
o Tube arrangement (e.g. Below First Row)
Only use this option when individual tubes are connected in series (usually by U-bends).

October 2020
Simulations
The process of creating a heat exchanger depends upon the options that you choose. For
example, if you choose the Generic option, then you use the Tube Bundle button to place tube
bundles in the drawing area, as shown below:
Figure 6-21. Geometric Heat Exchange Wizard - Generic Tube Arrangement

Example
Having placed the bundles, you then make the connections between the tube bundles, nodes,
and the Outside and Inside Flow starting and terminating points.

October 2020
Simulations
If you choose the Fin and Tube option, then what you see is the view shown below:
Figure 6-22. Geometric Heat Exchange Wizard - Fin and Tube Example
The view that you see is the tube bundle end-on. In the view above, the arrows indicate the flow
direction. They are also used to identify the entry and exit points. The connection between these
points and the actual terminals is implicit.
Note
If you close the network and re-open it and then open the wizard, then depending on what
option you initially chose, you will see that the heat exchanger you created is in place and
the script is retained.
If you decide to make a change at this point, you will need to edit or recreate the script to reflect
the changes.
If you choose the Generic option, then the wizard creates a script which defines the connections
between the tube bundles, nodes and the red and blue terminal nodes Outside Stream
terminating point.

October 2020
Simulations
If you choose the Fin and Tube option, then the wizard creates a script that defines the
connectivity between the tubes and any implicit nodes that are created. Implicit nodes are not
visible in the wizard. They are created when the output from one tube branches to two other
tubes, as shown in the example below:
Figure 6-23. Fin and Tube Example - Showing Implicit Nodes
Geometric Heat Exchanger Wizard - Scripts and Data Structure . . . . . . . . . . . . . . . . . 193

Geometric Heat Exchanger Wizard - Connectivity Examples . . . . . . . . . . . . . . . . . . . . 195
Using the Geometric Heat Exchanger Wizard - Creating a Generic Heat Exchanger . 198
Using the Geometric Heat Exchanger Wizard - Creating a Fin and Tube Heat Exchanger
204
Exchanger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

October 2020
Simulations
Geometric Heat Exchanger Wizard - Scripts and Data Structure
Geometric Heat Exchanger Wizard - Scripts and

Data Structure
During use, the Geometric Heat Exchanger Wizard creates a script which is used to store the
heat exchanger tube and fin connectivity configuration.
You can review and edit the script.
For general information on using scripts see “Catalogues - Scripts” on page 367.
Figure 6-24. Geometric Heat Exchanger Wizard - Example Script
Script Structure
Fields are presented in columns separated by one or more Tab or Space characters. Lines
starting with //, !, or # are comments.
There are two types of item – Tube Bundle and Node.

October 2020
Simulations
Geometric Heat Exchanger Wizard - Scripts and Data Structure
• A Tube Bundle data line starts with TB followed by three or four numbers representing:
o ID number – the unique ID of the Tube Bundle
o Next Inside – the unique ID of the next item in the inside stream
o Next Outside – the unique ID of the next item in the outside stream
o Number of Tubes in Bundle – an optional value, assumed 1 if not supplied
• A Node data line starts with ND followed by two or more numbers representing:
o ID number – the unique ID of the Node
o Next Item – the unique ID of the next item
The exit from the Heat Exchanger is designated by an item with ID = 0. Inside 0 corresponds to
the network node attached to Arm 2 of the parent Geometric Heat Exchanger. Outside 0
corresponds to the network node attached to Arm 4 of the parent Geometric Heat Exchanger
Connectivity
A Tube Bundle can connect to either:
• Another Tube Bundle

• A Node
• Item 0 (the exit)
A Node can connect to either:
• One or more Tube Bundles

• Item 0 (the exit)
Note
A Tube Bundle and a Node cannot have the same number.
Usage Guidelines
A Tube Bundle can connect to only one other item in each stream; you cannot branch the
streams.
A number of Tube Bundles may reference the same Next Item and so merge the stream.
Nodes are passive items and are not needed to connect one Tube Bundle to another; their main
purpose is to allow branching of a stream to several parallel Tube Bundles.
External node connection is optional and when not supplied, is deduced by the Geometric Heat
Exchanger.

October 2020
Simulations
Geometric Heat Exchanger Wizard - Connectivity Examples
Tip
It is recommend that you specify the external node connection since this makes the Tube
Connectivity Data in the script easier to understand, especially of the stream branches on
entry.
Geometric Heat Exchanger Wizard - Connectivity

Examples
Examples of the script output for various tube/bundle configurations are provided.
Original Network
The examples are all based upon the following network and assume that there are 7 tubes in
each bundle.
Figure 6-25. Geometric Heat Exchanger Wizard - Example Network

October 2020
Simulations
Case 1
Simcenter Flomaster connectivity 1:
//
TB 6 7 0 7
TB 7 8 0 7
TB 8 9 0 7
TB 9 10 0 7
TB 10 11 0 7
TB 11 0 0 7
ND 4 6 7 8 9 10 11
ND 1 6
Figure 6-26. Geometric Heat Exchanger Wizard - Virtual network

Corresponding to Connectivity Example 1
Case 2
//
TB 6 7 0 7
TB 7 8 0 7
TB 8 0 0 7
TB 9 10 0 7
TB 10 11 0 7
TB 11 0 0 7
ND 4 6 7 8 9 10 11
ND 1 6 9

October 2020
Simulations

Case 3
//
TB 6 7 0 7
TB 7 8 0 7
TB 8 0 0 7
TB 9 10 6 7
TB 10 11 7 7
TB 11 0 8 7
ND 4 9 10 11
ND 1 6 9

October 2020
Simulations
Using the Geometric Heat Exchanger Wizard - Creating a Generic Heat Exchanger

Using the Geometric Heat Exchanger Wizard -

Creating a Generic Heat Exchanger
This topic provides an example of creating a generic heat exchanger using the Geometric Heat
Exchanger wizard.
Prerequisites
Open a network which contains a heat exchanger component
Procedure
1. Click in the cell next to Heat Tube Connectivity and click the button. The Geometric
Wizard is displayed.

October 2020
Simulations
2. Select the Generic option and click Next. The view changes to the one shown below,
which has been annotated:
Figure 6-29. Geometric Heat Exchange Wizard - Starting Point
In the above view, the red and blue circles represent connection nodes which are shown
in their default positions. These nodes can be moved, or enlarged. If you select one it
looks like this:
By grabbing a handle with the mouse, you can change the size of the node. If you
position the mouse on the node, you can move it to another position.
The red node at the left is the starting point for the Inside Stream and the one to the right
is the terminating point. The blue node at the bottom is the starting point for the Outside
Stream (the air flow) and the node at the top is the terminating point.
3. Place the tube bundles in the drawing area by clicking the Tube Bundle button and then
clicking the drawing area to place the bundle.
As long as the button is depressed, you can continue to place tube bundles in the
drawing area.

October 2020
Simulations
4. The number shown on the bundle indicates the number of tubes in the bundle, in this
case 1. To increase the number of tubes, click the required tube bundle and enter the new
number:
5. Make the following connections:

• The connections between each tube bundle.
• The connections to the terminal points, as shown in Figure 2.
Figure 6-30 shows an example which has four tube bundles.
Note
A node (9) has been added since the output from tube bundle 6 also connects to the
inputs of tube bundles 7 and 8.
Newly added nodes are displayed as neutral (gray); they only change color when
connected.

October 2020
Simulations
Figure 6-30. Geometric Heat Exchange Wizard - Generic Example
6. Click the Finish button.

7. To see the script that is created click in the cell next to Heat Tube Connectivity to
display two buttons. Click the D.. button to display the script:
Figure 6-31. Geometric Heat Exchange Wizard - Generic Example Script

October 2020
Simulations
Where:
• Line 1
Indicates the type of heat exchanger: 0 = Generic, 1 = Fin and Tube
• Line 2
Column 1: TB = Tube Bundle
For the successive columns, then
Column 2: Indicates the particular tube bundle, in this case 5
Column 3: Indicates that tube bundle 5 is connected to tube bundle 6.
Column 4: Indicates where the outside connection of the tube bundle terminates
(indicated by 0). In this case, it shows that tube bundle 6 is connected to the Outside
Stream terminating point.
Column 5: Indicates the number of tubes in the tube bundle, in this case 1.
• Line 3
Using the above details and Figure 6-31, then it shows that the output of tube bundle
6 is connected to node 9. This is the node where the output from tube bundle 6
branches to tube bundles 7 and 8. It also indicates that (i) it is connected to the
Outside Stream terminating point and (ii) it has 1 tube in the tube bundle.
• Line 4
Using Figure 6-31, then column 3 shows that the output of tube bundle 7 is
connected to the Inside Stream terminating point (indicated by 0). Column 4 shows
that the outside connection is connected to the Outside Stream terminating point. It
also has one tube in the tube bundle.
• Line 5
Using Figure 6-31, then column 3 shows that the output of tube bundle 8 is
connected to the Inside Stream terminating point (indicated by 0). Column 4 shows
that the outside connection is connected to the Outside Stream terminating point. It
also has one tube in the tube bundle.
• Line 6
Using Figure 6-31, then:
Column 1: ND = Node. Column 2 indicates the node itself (9). The remaining
columns indicate the tube bundles to which the node connects (in this case tube
bundles 7 and 8).

October 2020
Simulations
Note
If you make a mistake while creating a link between two tube bundles, then by
clicking-on the link to highlight it you can delete it. If you were to make mistake
and continue to press the 'Finish' key, then an error message would be displayed.
Take the example shown below; you can see that there is a missing link from the
output of tube bundle 3.
Figure 6-32. Example with Missing Link
8. If, at this point, you were to click the Finish button the following message would be
displayed:
The script that would be generated in this case is shown below.

October 2020
Simulations
Note
You can see that there is no record for tube bundle 3.

Creating a Fin and Tube Heat Exchanger
You can use the Geometric Heat Exchanger Wizard to create Fin and Tube type heat
exchangers.
Prerequisites
• An open a network which contains either a AC Cross-flow Heat Exchanger, AC Heat
Exchanger, or Heat Exchanger: Cross Flow component
Procedure
1. Click in the cell next to Heat Tube Connectivity and click the button.
The Geometric Wizard is displayed.

2. Select the Fin and Tube option and click Next.
3. Enter the required number of tubes per row and the number of tube rows.
4. Set the Tube Arrangement by selecting an option from the tube arrangement dropdown
list.

October 2020
Simulations
Figure 6-33. Geometric Heat Exchange Wizard - Tube Arrangements
5. Click Next.
The example below uses the Below First Row option.

October 2020
Simulations
Figure 6-34. Geometric Heat Exchange Wizard - Fin and Tube Example
6. Connect the tube bundles.

In the example above, the outside stream flows from 5 to 3 to 4 (then exits), from 6 to 7
to 2 (then exits) but has nowhere to go from 8. As such, an outside node is then created
which branches the stream from 7 to 1 and 2.
7. Click Finish.

October 2020
Simulations
8. You can review the script by clicking in the cell next to Heat Tube Connectivity to
display two buttons. Click the D.. button to display the script:

October 2020
Simulations
Results
Considering Figure 6-35 which shows the numbered tube bundles, implicit nodes and air flows:
Figure 6-35. Geometric Heat Exchange Wizard - Numbered Tube Bundles,
Implicit Nodes and Air Flows
Table 6-13. Geometric Heat Exchange Wizard - Script

Line Number Meaning
1 Indicates the type of heat exchanger, in this case: Fin and Tube
2 • Tube arrangement, in this case 'Below First Row'
Number of tubes per row (3), and
• Number of tube rows (3).

October 2020
Simulations
Table 6-13. Geometric Heat Exchange Wizard - Script (cont.)

Line Number Meaning
3 • Column 1: TB = Tube Bundle
For the successive columns, then
• Column 2 and 3: Indicate that tube bundle 1 is connected to tube
bundle 2.
• Column 4: Indicates where the outside flow goes after leaving the
current tube bundle. 0 = exit.
4 • Columns 2 and 3: Indicate that tube bundle 2 is connected to tube
bundle 3.
5 • Columns 2: Indicates that tube bundle 3 is connected to implicit Node
10 (column 3).
• Column 4: Indicates that tube bundle 4 is connected to implicit Node
10 (column 3).
6 • Columns 2 and 3: Indicate that tube bundle 4 is connected to tube
bundle 5.
7 • Columns 2 and 3: Indicate that tube bundle 5 is connected to the
implicit inside termination point. This is indicated by 0 in column 3.
• Column 4: Indicates that tube bundle 3 is behind the current tube in the
outside flow.
8 • Column 2: Indicates that tube bundle 6 is connected to implicit Node 9
(column 4).
• Column 3: Indicates that tube bundle 7 is connected to implicit Node 9
(column 4).
9 Column 2, 3 and 4: Indicate that tube bundle 7 is connected to tube bundle
8, and that tube bundle 2 is behind tube bundle 7 on the outside flow.
10 Columns 2, 3 and 4: Indicate that tube bundle 8 is: (i) connected to the
implicit inside termination point (indicated by 0 in column 3) and (ii) to
implicit Node 9.
11 Column 1: ND = Node. Column 2 indicates the implicit node itself (9).
The remaining columns indicate the tube bundles to which the node
connects (in this case tube bundles 2 and 1).
12 Column 1: ND = Node. Column 2 indicates the implicit node itself (10).
The remaining columns indicate the tube bundles to which the node
connects (in this case tube bundles 4 and 6).

October 2020
Simulations
Using the Geometric Heat Exchanger Wizard - Creating a Serpentine Fin and Tube Heat Exchanger
Note
If you make a mistake while creating a link you can select it and press the delete key to
delete it.

Creating a Serpentine Fin and Tube Heat
Exchanger
You can use the Geometric Heat Exchanger Wizard to create Serpentine Fin and Tube type heat
exchangers.
Prerequisites
• An open a network which contains either a AC Cross-flow Heat Exchanger, AC Heat
Exchanger, or Heat Exchanger: Cross Flow component
Procedure
1. Open the Wizard and choose the Tube and Fin option.
2. Set the Number of Tubes per Row to 7.
3. Set the Number of Tubes Rows to 1.
4. To produce a serpentine heat exchanger, select the In Line with First Row option.
The above settings produce a single line of tube bundles.
5. Click Next button.

October 2020
Simulations
Using the Geometric Heat Exchanger Wizard - Creating a Serpentine Fin and Tube Heat Exchanger
The script that is created for this type of configuration is shown below:
Figure 6-36. Geometric Heat Exchange Wizard - Serpentine Heat Exchanger
Script

October 2020
Simulations
Hydraulic Gradient Lines
Hydraulic Gradient Lines

You can use Hydraulic Gradient Lines to look at the pressure waves that may occur in a piping
network during a Transient simulation.
Hydraulic Gradient Line - Worked Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Hydraulic Gradient Line - Worked Example

This example shows how to create and view the Hydraulic Gradient Lines for a simple rising
main network.
Figure 6-37. Hydraulic Gradient Line Example Network
Using the above network, we will create a Hydraulic Gradient Line that looks at the flow
conditions between Nodes 4 and 7.
The example involves:
1. Setting the Component and Node Data
2. Run the Simulation
3. Collect the Components and Nodes for the Plot
4. Viewing the Results
5. Creating the Hydraulic Gradient Line Plot

October 2020
Simulations
6. Exporting Hydraulic Gradient Line Data to Excel
1. Setting the Component and Node Data

Note
Only required data is shown. All other data is either Not Set, or set to their default values.
Table 6-14. Hydraulic Gradient Line Example - Component and Node Data
Component Component Name Input Parameter Value/Units
Number
1 Reservoir: Constant Pipe Diameter 0.3 m
Head
Liquid Level above Base 0m
Base Level above Reference 0m
Surface Pressure 1 bar
2&3 Pump: Radial Flow Rated Flow 0.1 m3/s
Rated Head 50 m
Rated Speed 954 rpm
Rated Power 65.4 kW
Pump Inertia 4 kg m2
Motor Inertia 2 kg m2
Speed Ratio 1 kg m2
Friction Torque 0 Nm
Initial Speed 954 rpm
Initial Logic State -1 Running at
Constant Speed
Pump: Radial Flow Switch Time 4s
Component 3 only
Logic State 0. Motor Off -
Pump Tripped
Switch Time 80 s
Logic State 0. Motor Off -
Pump Tripped

October 2020
Simulations
Number
4&5 Valve: Swing Check Diameter 0.3 m
Characteristic Operating Time 1s
Minimum Velocity 1 m/s
Head Loss v Fluid Velocity Set
6, 7, 8 & 12 Pipe: Cylindrical Elastic Length 100 m
Diameter 0.3 bar
Wave Speed 1000 m/s
Friction Data (Sub-Form) Friction Option 1. Colebrook-
White
Absolute Roughness 0.025 mm
9 Reservoir: Infinite Area Outflow Loss Coefficient 3
Inflow Loss Coefficient 3
Pipe Diameter 0.15 m
Liquid Level above Base 50 m
Surface Pressure 1 bar
10 Valve Opening Tabular Output Quantity 17. Valve
Controller Opening
1st Time 0s
Valve Position at 1st Time 1 ratio
2nd Time 0.5 s
Valve Position at 2nd Time 0.5 ratio
3rd Time 1s
Valve Position at 3rd Time 0.22 ratio
4th Time 2s
Valve Position at 4th Time 0 ratio
5th Time 11 s
Valve Position at 5th Time 0 ratio
11 Valve: Butterfly (Type Diameter 0.2 m
A)
Valve Opening 0.2 ratio

October 2020
Simulations
Number
12 Pipe: Cylindrical Elastic Length 100 m
Diameter 0.2 bar
Wave Speed 1000 m/s
Friction Data (Sub-Form) Friction Option 1. Colebrook-
White
13 Reservoir: Constant Pipe Diameter 0.2 m
Head
Surface Pressure 1
Set the Node levels:
• Node 5 - 20 m
• Node 6 - 45 m
• Node 7 - 50 m
• Node 8 - 40 m
• Node 9 - 20 m
For Node 9 set Auto-vaporization to: 1.Yes
2. Run the Simulation

1. Click the Simulation Data tab to see the General Data and Simulation Control form.
2. Click in the cell next to Simulation Type and choose the Incompressible Transient
option.
3. Set the Time Step to 0.01, the Simulation Start Time to 0 seconds, and the Simulation
End Time to 10 seconds.
4. Click Run to start the simulation.
3. Collect the Components and Nodes for the Plot

Note
The collected nodes and components must form a continuous string that starts and ends at a
node.

October 2020
Simulations
1. Add the components and nodes to the collection starting at Node 4 and ending at Node
7.
For more information on collecting components and nodes see “Using the Collection
List” on page 118.
4. Viewing the Results

Create an overlay plot for Nodes 4 and 7. To do this:
1. Click the Results radio button and select Node 4 to display its properties in the bottom
pane.
2. Select Node 4 in the Collection table.

October 2020
Simulations
3. Click in the cell next to Pressure and click the button. A plot window opens showing
the plot below:
4. To overlay the data for Node 7, with the plot window still open, click the button.

October 2020
Simulations
5. Select Node 7 in the Collection table. Click in the cell next to Pressure and click the
button to display the overlay plot shown below:
5. Creating the Hydraulic Gradient Line Plot

1. Click the Result Sets/Audit tab.
2. Click the button (on the Post Processing toolbar).

October 2020
Simulations
A new tab opens displaying the Hydraulic Gradient Lines.

View the profile from the By default the start of the string is the first node, in this case
other end of the string of 4.
nodes/components. To start the profile from the other end, click the dropdown
list and select the required node.
Use a different Fluid Density. By default a suitable value is displayed.
To set another value, click the dropdown list or input your
own value.
You can change the units using the units dropdown list.
Change the value for Gravity. If the Acceleration due to Gravity data (on the Ambient
Conditions sub-form) item is not set, then simulation
assumes 9.80665 m/s2.
To change this, input your own value and use the dropdown
list to specify the units.

October 2020
Simulations
Using the Time Step Wizard

Specify a different start or Use the Start Time and End Time fields.
stop time for the gradient You can change the units using the units dropdown list.
lines.
Specify an absolute height The Hydraulic Gradient Lines displayed for a series of
value for the first node in the nodes and components are based upon changes to the Head/
chain. Elevation relative to the starting point (the first node in the
chain).
Specify an absolute height for the first node by entering a
new value in the Initial Chainage field and setting the units.
Use a different ambient By default the gradient lines display as absolute pressure v
pressure value. pipe length. You can specify that instead they are displayed
relative to another value.
To do this, select the Use Relative Pressure Head option.
You can then, if required, specify the Ambient Pressure and
set the units.
Display an offset line for the The values for maximum and minimum head pressure can
pipe profile. be close to the pipe profile line. In these instances it is
useful to display an offset line for the pipe profile.
To do this, check the Use Offset On Pipe Profile and then
use the Pressure Offset field (and units dropdown) to
specify the size of the offset.
Display the minimum and Select the Show Min. and Max. Difference option.
maximum difference points
(from the pipe profile line).
6. Exporting Hydraulic Gradient Line Data to Excel

1. To export the current Hydraulic Grade Line data to Excel, click the Excel Export
button.

The Time Step Calculator is a wizard that calculates the time step based upon information about
the wave speed and pipe information.
The wizard uses the following input information:
• Default wave speed

• Allowed % diff in wave speed
• Minimum number of reach lengths

October 2020
Simulations
• Minimum pipe length

• Convergence factor.
Using this information (which you can adjust), the wizard calculates the best time step for all
the elastic pipes in the network (providing they are longer than the minimum pipe length).
Procedure
1. Click the Simulation Data tab to see the simulation data.
2. Click in the cell next to Time Step to display the following:
3. Click the button to display the wizard, as shown below:

October 2020
Simulations
4. Specify the Calculation Criteria:

a. Change the default wave speed - Click in the adjacent cell and enter the required
value.
Note
The value displayed, is the value entered on the data form. If no value is set on
the data form, then whatever value you enter will be used when you come run the
simulation.
a. Adjust the Allowed % diff in wave speed - Click in the adjacent cell and enter the
required value.
b. Adjust the Minimum number of reach lengths - Click in the adjacent cell and enter
the required value.
Note
Simcenter Flomaster recommends that the minimum number of reach lengths is
three.
c. Adjust the Minimum pipe length - Click in the adjacent cell and enter the required
value.
Note
If a pipe is below the minimum recommended length, then it will be ignored
when you come run the simulation.
d. Adjust the Convergence factor - Click in the adjacent cell and enter the required
value.
Note
Values entered must be positive values less than 0.1. Also, the smaller you make
the Convergence factor, than the larger the time step becomes.

October 2020
Simulations
5. Re-Calculate the Wave Speed and Time Step:

a. Click Next button to display the view shown below:
The dialog box shows the details of all the pipes in the network whose length is
above the minimum setting.

October 2020
Simulations
b. To see details about any short pipes in the network click the Short Pipes button to
display the dialog box shown below:
c. Click the Finish button. The Proceed dialog box is displayed.

d. Click Yes to enter the calculated time step.

October 2020
Chapter 7
Catalogues
Catalogues are used to hold the analytical models, components, materials, performance data,
scripts, sub-systems, and symbols that you use to create networks.
• Analytical Models—holds the mathematical representations of all of the
Simcenter Flomaster components.
• Components—holds a list of all of the Simcenter Flomaster supplied components. Each
group of components (for example, Bends) is stored in a sub-catalogue.
• Materials—holds all of the Simcenter Flomaster supplied fluids, liquids, and solids.
Also supplied is a range of templates that you can use to create new fluids, liquids, or
solids.
• Performance Data—holds all of the supplied Simcenter Flomaster equations, curves,
surfaces, and so on.
• Scripts—holds all of the Simcenter Flomaster supplied scripts. This catalogue is also
used to hold scripts that are used by upgraded networks, and scripts that have been
unpacked. It also contains a sub-catalogue—Macros—used to hold both the
Simcenter Flomaster supplied macros and those that you create.
• Sub-systems—used to store the sub-circuits that you can create for use in other
networks.
• Symbols—holds symbols for all of the Simcenter Flomaster supplied components.
For each catalogue described above, you can create sub-catalogues to hold items that you create.
For example, you could add a sub-catalogue to the Performance Data catalogue to hold all of
your own curves, equations, surfaces, and so on, that are used by special applications; this
approach enables you to keep the items you create separate from those supplied by
Catalogues Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

Searching for Items in the Catalogues Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Catalogue Item Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Creating Shortcuts to Catalogue Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Catalogues - Analytical Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Context Dependency Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Dependency Rules Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

October 2020
Catalogues

Selection from Catalogue Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Feature Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Example: Creating a CAM Using Performance Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Catalogues - Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Customizing Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Component Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Composite Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Viewing Extended Properties for Components or Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Copy Features to Other Components and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Catalogues - Materials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Create a New Material Based on a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Copying Materials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Materials Based On External Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Catalogues - Performance Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Displaying Performance Data as Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Creating New Nusselt Surfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Catalogues - Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Creating Scripts - General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Catalogues - Sub-systems and Sub-circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Catalogues - Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

October 2020
Catalogues
Catalogues Tab
Catalogues Tab
To access: Select View > Project View and choose the Catalogues tab.
Used to view and manage catalogues.
Objects
Table 7-1. Catalogues Tab Contents
Field Description
Catalogue Tree View List all catalogues and their contents. Click the plus (+) symbol
to the left of a Catalogue to expand it and view its contents.
Choose an item from a catalogue to view its properties.
Properties View Displays the following properties for an Catalogue or item
selected in the tree view:
• Name—the name of the object. When you create your own
Catalogue or component, its name is displayed in this field.
• Description—click in the adjacent field and click the
button; a dialog box opens displaying a text description of
the Catalogue or component.
• Created/Modified—the date the item was created and/or
modified.
• Status—the status of the object (for example, prototype,
development model, and so on).
• Unique Identifier—a system-generated ID that ensures
uniqueness within the database.
• Protected—specifies whether the item may be edited or not.
Certain item types may be protected using this field; see
below.
• Path—displays the Catalogue and any sub-catalogues in
which the item is located.
Usage Notes
• To add a new Catalogue, right-click in the top tree view and select New Catalogue, then
edit the Name property of the New Catalogue Header object to the required name. Click
in the tree view to apply the name change.
• To protect an item in a Catalogue, select it in the tree view and then change the value of
its Protected property from No to Yes. Alternatively, right-click the object and toggle
the Protected option in the popup menu. See Catalogue Item Protection for more
information.
• To add an item to a catalogue, right-click the catalogue and select New > [item_type],
where [item_type] is dependant on the catalogue to which you are adding an item.

October 2020
Catalogues
Searching for Items in the Catalogues Tab
The Selection from Catalogue dialog box opens, allowing you to choose a
Simcenter Flomaster supplied item upon which to base the item you are creating.
Search for the item, and then click Select… A subsequent dialog box may be displayed
to allow you to configure the new item before it is created; this depends on the item type.
Once the item has been added to the catalogue, you can select it and edit its Name
property.
Searching for Items in the Catalogues Tab

There are tools which can help you find items such as Components or Materials in the
Catalogues Tab.
Procedure
1. Select the Catalogues Tab in the Project View pane.
2. To limit the view to only draggable items (typically only Components and Sub-Systems)
click the button. Click the button again to see all catalogue items.
3. You can create more space in the Project View pane by switching the Properties table
off. Click the button to hide the Properties table. Click the button again to show the
Properties table.
4. You can filter catalogue items according to their name. Type a word or part of a word in
the Filter text... field and only the catalogue items which contain that text in their name
will be displayed. Clicking the X button clears the filter.
Catalogue Item Protection

You can protect your user-created catalogue items to prevent edits by users with insufficient
privileges.
You can protect:
• Components
• Materials
• Performance Data
• Scripts
Once protected, the editor for these items displays PROTECTED in the title bar, and the OK
button is disabled.

October 2020
Catalogues
Creating Shortcuts to Catalogue Items
Note
Simcenter Flomaster supplied items are always protected - this cannot be changed.
Shortcuts of items retain the protection status of the original, but copying, packing, and
unpacking items clears their protected status (the items become unprotected). Unprotected items
contained in a protected item remain unprotected.
The ability to set an item’s Protected property is controlled by the Catalogue Items Protect
permission, which is available (by default) to Administrators only.

You can create shortcuts to any items in the Simcenter Flomaster catalogues (or catalogues that
you have created yourself). This can be useful for managing catalogue contents.
For example, you may have a catalogue that you have created that holds all your own
performance curves, but you want to also, regularly access to a Simcenter Flomaster supplied
curve. By creating a shortcut of the Simcenter Flomaster supplied curve in your own catalogue
you can access it as if it was in that catalogue.
You can create shortcuts to:
• Analytical Models
• Components
• Materials - including:
o AC fluids
o Compressible and Incompressible fluids
o Solids
o User-defined gases, fluids and solids.
• Performance Data - which includes:
o Curves
o 2D and 3D Equations
o Surfaces
o User-defined curves, equations and surfaces
• Scripts and Macros
• Symbols

October 2020
Catalogues
Procedure
Right-click on the folder and select Create Shortcut.

October 2020
Catalogues
Catalogues - Analytical Models
Catalogues - Analytical Models

Each Simcenter Flomaster supplied model is a mathematical representation of a component (for
example, a bend, a discrete loss, and so on) or a material (for example, a fluid, a liquid, and so
on). Each model includes all of the equations and features used by the simulation. Analytical
Models are used as the basis for all of the physical components and materials used in networks.
Before creating an analytical model you should:
1. Determine the model type you need (for example, component, composite, liquid, and so
on).
2. Search the database to see if there is an existing Simcenter Flomaster supplied model
that suits your requirements. If there is, use that instead of creating a new model.
3. If you cannot find a suitable model, make a copy of one that best suits your requirements
and then customize it.
Context Dependency Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Dependency Rules Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Selection from Catalogue Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Feature Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Creating Option Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Creating Curve or Equation Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Example: Creating a CAM Using Performance Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Example: Creating a CAM Using Performance Data - Deriving the Linear Coefficients for a
Loss . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Example: Creating a CAM Using Performance Data - Creating the CAM . . . . . . . . . . . . 250
Example: Creating a CAM Using Performance Data - Generating the Code Stub . . . . . . 252
Example: Creating a CAM Using Performance Data - Creating a new Project and adding the
Code Stub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Example: Creating a CAM using Performance Data - Editing the Code Stub . . . . . . . . . . 255
Example: Creating a CAM Using Performance Data - Compiling the Code and Copying the .dll
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Example: Creating a CAM Using Performance Data - Creating and Customizing a Component

October 2020
Catalogues
Creating Analytical Models
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
264
Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

You can create your own analytical models.
Prerequisites
• This procedure assumes that you have created a sub-catalogue named “User-defined” in
the Analytical Models catalogue and that intend to create a new analytical model in that
sub-catalogue.
Procedure
Note
When creating new analytical models, it is best practice to create a new sub-
catalogue in the relevant component-type catalogue, and to create your new model
there. In this way all of your models are kept separate from those supplied by
Simcenter Flomaster
1. On the Catalogues Tab of the Project View, navigate to

Flomaster > Analytical Models > User-defined, then right-click and select New >
[component_type]. The Analytical Model Editor Dialog Box opens.
2. Enter a Name for the model and, if required, add a description to explain how it is used.
3. Add the required model features by either:
• Clicking Add Existing… and selecting a Simcenter Flomaster supplied feature to
use.
• Clicking Add New… and defining a new feature.
4. For each feature you add, define the necessity rules by selecting the Requirement type
for each Simulation Type. If the Requirement type is Context Dependent:
a. Click Context Dependency Rules… to open the Dependency Rules Dialog Box and
specify the criteria by which the context is defined.
5. Click OK.
Results
The model is added to the catalogue.

October 2020
Catalogues
Related Topics
Analytical Model Editor Dialog Box

October 2020
Catalogues

To access, either:
• Double-click an analytical model in the Catalogues TabCatalogues Tab.
Note
For Simcenter Flomaster supplied analytical models the dialog box is read only.
• Right-click one of the Analytical Models catalogues or sub-catalogues and select

New > [model_type]. The dialog box opens with no properties defined, allowing you to
define a new model.
Used to view, create, and edit analytical models.
Objects
Table 7-2. Analytical Model Editor Dialog Box
Field Description
Name The component name, mirroring the value of the Name property
on the Catalogues Tab
Description Details the component’s characteristics and usage.
Arm Connections Specify the number of physical connections the component has.
Click Edit Arms to open the Component Connections Dialog Box
and configure each arm connection.
Signal Connections Click Edit Signals... to access the Component Signal Connections
Dialog Box and specify the component’s signal connections.
Sub-Form Type
Historical Analysis Ref
Historic File Name
Features List Lists all of the features selected for the component, and the values
assigned to each of the features’ attributes.
Necessity List Specifies whether a feature is required or not for this component
on a per-analysis basis. The options are Mandatory, Not Needed,
Optional, and Context Dependent. In the case of Context
Dependent, click Context Dependency Rules... to access the
Dependency Rules Dialog Box and specify the criteria that must
be satisfied in order for the simulation requirement to be met.
Generate Code Stub… Opens the Code Stub Generation Dialog Box.

October 2020
Catalogues
Context Dependency Rules
Usage Notes
• To add a feature to a model either:
o Click Add Existing… to open the Feature Selection dialog box and select from one
of the Simcenter Flomaster supplied features.
o Click Add New… to open the Feature Type dialog box and specify the type of
feature to add (select from the list of supported types). After clicking OK, a second
dialog box enables you to specify the feature properties; this dialog box will offer
different options based on the feature type you previously selected.
Related Topics

Context Dependency is a mechanism whereby you set rules, which determine the dependency
between data items and data groups.
For example, consider the Discrete Loss component. For Incompressible simulations the
Pressure Loss can be defined in one of four ways:
• Specify a fixed value of loss coefficient, K, irrespective of flow conditions.

• Specify a curve that describes the variation of pressure loss with flow rate through the
component.
• Specify curves that describe the variation of pressure loss with flow velocity through the
component.
• Specify curves that describe the variation of loss coefficient with Reynolds Number,
through the component.
The above data items and curves are considered “context dependent” for incompressible
simulations. For compressible simulations (except restart simulations) the conditions are
different—the fixed values of forward and reverse loss coefficient are mandatory. In other
words, they are not context dependent and the curves are not required at all.
Related Topics
Dependency Rules Dialog Box

October 2020
Catalogues

To access: Click Context Dependency Rules… on the Analytical Model Editor Dialog Box.
Used to construct the Dependency Rules controlling the component features considered for
different simulation types.
Objects
Table 7-3. Dependency Rules Dialog Box Contents
Field Description
Simulation Dependency Select the simulation type for which you are creating
dependency rules.
Rules Blank by default, you can add an Option or Alternatives rule to
this list by clicking the appropriate button below the option or
alternatives field.
You can rename a rule by clicking the Name value and editing
it.
You can edit or delete existing rules.
Option Rule Pane Displayed when an Option Rule is selected in the Rules list.
Click the browse, [...], button to choose an Option feature
assigned to the component.
Alternatives Rule Pane Displayed when an Alternative Rule is selected in the Rules
list. Click Add Group… and use the Select Features to Group
dialog box to specify a Group No. and the features to include in
the group
Tip: hold down CTRL while selecting multiple features
Related Topics
About Alternative Rules

Alternative Rules allow you to specify that a feature should only be considered in a simulation
type when there is sufficient data to calculate it. Since there may be multiple ways to calculate
the same value, Alternative Rules allow you to specify multiple combinations of features that,
together, can satisfy the requirement to calculate a feature value, and therefore include it in a
simulation.
For example, Table 7-4 shows the groups of data that can be used to define the pressure loss for
the discrete loss. Each data group is the minimum data required for the component to function;
the remaining groups are the alternative groups of data that can be used.

October 2020
Catalogues
About Alternative Rules
Table 7-4. Required Features

Data Group Required Features
1 Area +
Forward Loss Coefficient
Reverse Loss Coefficient
2 Area+
Forward Pressure Loss v Flow Rate
Reverse Pressure Loss v Flow Rate
3 Area+
Forward Pressure Loss v Velocity
Reverse Pressure Loss v Velocity
4 Area+Hydraulic Diameter
Forward Loss Coefficient v Reynolds Number
Reverse Loss Coefficient v Reynolds Number

October 2020
Catalogues
Component Connections Dialog Box

To access: Click Edit Arms… on the Analytical Model Editor Dialog Box.
Used to add connections (arms) to component models and to define the number of internal
circuits through which fluids can flow between connections.
Objects
Table 7-5. Component Connections Dialog Box Contents
Field Description
Number of separate internal circuits Specify the number of discrete hydraulic flow
paths available within the component. Each
arm you define is mapped to a circuit.
All arms have identical allowable external With this option selected, the allowable
connections external connections you specify are applied
to all arms.
Allowable External Arm Connections Specify the connection types that the arm
supports; only component arms that support
one of the selected types will be able to
connect to the component within a network.
Arm Placement and Internal Connectivity This list defines the positions (Placement)
within the component that each arm occupies,
defined as directions (minutes) on a clock
face. The Internal Circuit column enables you
to map each arm to a specific circuit (if you
have defined more than one for the
component) by entering the circuit number.
Click Graphical View... to see the layout.
Each arm is represented by a green triangle,
which you can drag to a new position,
updating the Placement value for that arm.
Fluid Interface Support
Related Topics
Component Signal Connections Dialog Box

October 2020
Catalogues

To access: Click Edit Signals… on the Analytical Model Editor Dialog Box.
Used to define the signals the component needs to receive from or send to other components on
a network.
Objects
Table 7-6. Component Signal Connections Dialog Box Contents
Field Description
Signal No. Read-only. Identifies the signal in the list.
Name Enter a descriptive name for the signal.
Placement Click Graphical View… to see the layout. Each signal is represented by a
yellow rectangle, which you can drag to a new position, updating the
Placement value for that signal.
Unit Quantity Select the physical value that the signal is to communicate.
Signal Type Specify whether the signal is an input or output.
Related Topics

October 2020
Catalogues
Code Stub Generation Dialog Box
Code Stub Generation Dialog Box

To access: Click Generate Code Stub… on the Analytical Model Editor Dialog Box.
Used to configure and export a model as a code stub file.
Objects
Table 7-7. Code Stub Generation Dialog
Field Description
Specify Inherited Interfaces Select the interfaces to make available to the code stub. Click
the plus (+) icons to expand the tree, and select the check
box(es) alongside the interface(s) to include.
Output Directory Specify the location in which to save the created code stub
file.
File Name Specify the name to give the created file.
Create File Click to close the dialog box and create the code stub file in
the specified location.

October 2020
Catalogues
Selection from Catalogue Dialog Box

To access either:
• Select Search from the Catalogue Item in the Catalogues Tab.
• Click the Select Item button [S…] to the right of the property field.
• Search for a macro, select Tools > Macros…
Used to find analytical models by matching one or more component properties.
Objects
Table 7-8. Selection from Catalogue Dialog Box Contents
Field Description
Browse Catalogues This tree menu lists all catalogues in the database that are applicable to the
object for which you are searching.
Choose a catalogue to see the contents listed in the Filtered Items list (the
list of items is affected by the Filter Options settings).
Filter Properties This list displays the generic properties applicable to all components, and
allows you to search on the value of each property.
To filter by a property, enter or choose a value, select the Check option
alongside to enable it, and then click Refresh.
Filter Options These options filter the scope of the search based on the number of
catalogues to include.
Filtered Items This list shows the results of your search.
Click Refresh at any time to update the list based on any edited search
parameters.
Choose an item in the list; the bottom list displays the item’s properties, the
Browse Catalogues list highlights the catalogue in which the item is
located.
Choose and Select Available only when searching for Analytical Models, Components,
‘Not Set’ Materials, Performance Data, Scripts, and Symbols.
With an item highlighted in the Filtered Items list, click Select to close the
dialog box.
Select the item in the Catalogues tab, and open the Analytical Model
Editor Dialog Box to display the item’s properties.
Clicking Select ‘Not Set’ closes the dialog box without returning a search
result.

October 2020
Catalogues
Table 7-8. Selection from Catalogue Dialog Box Contents (cont.)

Field Description
Create... A dropdown button which allows you to create a new Curve, 2D Equation,
or Pump Head Curve.
See “Creating New Curves and Surfaces” on page 332, “Creating
Equations” on page 341, or “Creating Pump Head Curves” on page 345 for
further information on these performance data items.
Execute and Exec. Available only when searching for Macros.
Async. Click Execute to run the macro immediately, disabling
Simcenter Flomaster until it completes.
Click Exec. Async to run the macro asynchronously
Note: Simcenter Flomaster will be usable while the macro executes but
actions may slow down the macro.

October 2020
Catalogues
Feature Types
Feature Types
Features define the function of a model within a network, specifying properties and behaviors
that can be set, read, and manipulated during simulation. All features belong to a single
category, or type.
When you create a new feature (rather than using an in-built feature) you must specify one of
the following types.
• Sub-forms
Used to set a sub-form option for example the Pipe Thermal Properties sub-form used to
set the required thermal properties.
Descriptive sub-forms allow you to enter descriptive data that can be of use to network
users. For example, if you use a particular kind of compressor in an automotive air
conditioning system, you could use this option to create a sub-form that allowed you to
enter data such as:
o The physical data of the component (e.g. height, weight, length)
o Performance data (e.g. cooling capacity, performance coefficient, etc)
• Real
Used to define input data and results (for example Diameter).
• Integer
Used to set integer values that are read by the model.
• Text
• Option
Prompts the user to select from a list of values before running the simulation. For
example, 1=On, 2=Off. See Creating Option Features.
• Liquid Option
• Gas Option
• Solid Option
• AC Fluid Option
• Humid Air Option
• Curve or Equation
Used to define an item of 2D performance data, such as a curve of Loss Coefficient v
Reynolds Number. See Creating Curve or Equation Features.
• Surface

October 2020
Catalogues
Feature Types
Used to define an item of 3D performance data, such as a surface of Forward Pressure

Loss V Flow Rate & Temperature.
• Script
Used to choose a script.
• Eagle Fluid Option
Creating Option Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Creating Curve or Equation Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Creating Option Features

When creating a new analytical model you can specify a list of values from which users can
select before running a simulation.
Prerequisites
• You must have created a user-defined analytical model for which to create the option
feature; see Creating Analytical Models.
• The user-defined model must be open in the Analytical Model Editor Dialog Box.
Procedure
1. In the Features list, click Add New… The Feature Type dialog box opens.
2. Select Option and click OK. The Option Feature dialog box opens.
3. Enter a Name for the feature, provide a Description as to its intended use, and then click
the browse (…) button to the right of the Option Form field. The Option List
Management and Selection dialog box is displayed.
4. Either:
• Select one of the pre-configured Option Lists and then click OK.
• Create a new Option List as follows:
i. Click New… The Option List Maintenance dialog box opens.
ii. Enter an Option List Name.
iii. Click Add List Item and enter a name and value for the new list item.
iv. Repeat step iii until you have defined all of the items for the list, and then click
OK.
The new option list is now available in the Option List Management and Selection
dialog box. Select it in the list and click OK.
5. On the Option Feature dialog box, click OK.

October 2020
Catalogues
Component Application Models
Results
The new option feature is added to the Features list of the Analytical Model Editor dialog box.
Creating Curve or Equation Features

When creating a new analytical model you can specify that the user selects a pair of values
(curve or equation) to define a two-dimensional representation of performance data.
Prerequisites
• You must have created a user-defined analytical model for which to create the curve or
equation feature; see Creating Analytical Models.
• The user-defined model must be open in the Analytical Model Editor Dialog Box.
Procedure
1. In the Features list, click Add New… The Feature Type dialog box opens.
2. Select Curve or Equation and click OK. The Curve or Equation Feature dialog box
opens.
3. Enter a Name for the feature, provide a Description as to its intended use, and then click
the browse (…) button to the right of the X-Axis Unit Quantity field. The Unit Quantity
Selector dialog box is displayed.
4. Select the unit quantity to use and click OK.
5. On the Curve or Equation Feature dialog box, click the browse (…) button to the right of
the Y-Axis Unit Quantity field and choose a second unit quantity to use.
6. Click OK.
Results
The new feature is added to the Features list of the Analytical Model Editor dialog box.

CAMs are the underlying building blocks for all of the Simcenter Flomaster components in a
network. Each component is based on a CAM, but some components, such as Control Valves,
share a common model. In this case, there is one CAM upon which most of the control valves
are based and each physical component’s data form has been modified to suit the actions of the
particular component. Certain data items that are relevant for one component can be hidden or
displayed, depending on the particular component being modeled.
Simcenter Flomaster contains pre-configured models upon which all of the physical
components are based. You can use these models as a basis for developing custom components.

October 2020
Catalogues
Steps
The steps to create a simple loss model are:
1. Example: Creating a CAM Using Performance Data - Creating the CAM:

a. Naming the model and giving it a description.
b. Defining the arm connections and their type.
c. Defining the input and output features.
2. Example: Creating a CAM Using Performance Data - Generating the Code Stub
3. Example: Creating a CAM Using Performance Data - Creating a new Project and adding
the Code Stub
4. Example: Creating a CAM Using Performance Data - Adding a Simcenter Flomaster
Reference
5. Example: Creating a CAM using Performance Data - Editing the Code Stub
6. Example: Creating a CAM Using Performance Data - Compiling the Code and Copying
the .dll
7. Creating the new component and customizing it, taking the new .dll and creating a
physical component that can be used in a network.
Requirements
A suitable C# editor is required to edit the code stub. If you do not have Microsoft® Visual
Studio® 2005 or 2008 installed, then an alternative is the Microsoft® Visual C#® 2008 Express
Edition.
Related Topics
Example: Creating a CAM Using Performance Data

October 2020
Catalogues

This example demonstrates the steps involved in creating a Component Application Model
(CAM) using performance data.
The model you will create is a simple loss model, which uses a curve of Loss Coefficient vs
Reynolds Number.
Note
This example also covers additional functions relating to the performance data available,
details of which can be found in Appendix A: Using Performance Data Functions.
The pressure/flow characteristic for the model is described below in terms of pressure
difference, with reference to density and velocity:
(7-1)
where:
• Δ = Pressure difference between arms 1 and 2

• K = Loss coefficient
• V = Fluid velocity
• ρ = Fluid density
In the model the loss coefficient, K, for forward flow is a function of the Reynolds Number.
This relationship is defined using a curve or equation on the component data form. The loss
coefficient is defined as a fixed value for reverse flow.
Note
The techniques used in the linearization of the coefficients used for the simulation are
described in Example: Creating a CAM Using Performance Data - Deriving the Linear
Coefficients for a Loss.

Example: Creating a CAM Using Performance Data - Deriving the Linear Coefficients for
a Loss. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Example: Creating a CAM Using Performance Data - Creating the CAM. . . . . . . . . . 250
Example: Creating a CAM Using Performance Data - Generating the Code Stub . . . 252
Example: Creating a CAM Using Performance Data - Creating a new Project and adding
the Code Stub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

October 2020
Catalogues

Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Example: Creating a CAM using Performance Data - Editing the Code Stub . . . . . . . 255
Example: Creating a CAM Using Performance Data - Compiling the Code and Copying the
.dll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Example: Creating a CAM Using Performance Data - Creating and Customizing a
Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Example: Creating a CAM Using Performance Data -

Deriving the Linear Coefficients for a Loss
This topic describes the general simulation method for isothermal flow through a two-armed
component. Simcenter Flomaster uses a linearization technique, which reduces a network fluid
flow problem to the solution of a set of linear coefficients.
For a steady-state simulation of a component in a network, Simcenter Flomaster requires the
mass flow rate to connected nodes to be expressed as linear functions of the pressure difference
across it. For a two-armed component, two equations are needed:
(7-2)
(7-3)
The terms An and Bn are known as linearization coefficients. It is these coefficients that you
must derive and return to Simcenter Flomaster. Simcenter Flomaster solves a network problem
by iterating for a converged mass flow solution. Therefore, equation 7-2 needs to be rewritten in
terms of mass flow as opposed to fluid mean velocity. Combining equation 7-2 with the
continuity equation for the component shown below:
(7-4)

October 2020
Catalogues
results in:
(7-5)
It is important to consider the direction of mass flow and the sign of the pressure change. The
sign convention for mass flow from a component to a node is positive. Equations 7-6 and 7-7
define the mass flow rate to the two arm connections.
(7-6)
(7-7)
Rearranging equations 7-6 and 7-7 into the general form of linear equations used by
Simcenter Flomaster gives:
(7-8)
(7-9)
Comparing the linear equations for a two-armed component (equation 7-2), shows that the
coefficients that must be returned to Simcenter Flomaster are given as:
(7-10)

October 2020
Catalogues
As there is no accumulation in the component, and the mass flow into the component is equal to
the mass flow out of the component, the equations shown above are symmetrical and are
redefined as follows:
(7-11)
For the discrete loss component, the B1 and B2 coefficients are zero. In the formulation of the
linear equations, the B coefficients represent a mass flow rate that is independent of pressure. In
the case of a discrete loss, there is no flow unless a pressure difference exists. For components
that input energy into a system, such as pumps, the linear equations will contain non-zero B
coefficients.

Creating the CAM
You can create your own Component Application Models (CAMs)
Prerequisites
• The Project View pane must be open, with the Catalogues Tab displayed.
Procedure
1. In the Catalogues list, navigate to Flomaster > Analytical Models, then right-click the
User-defined folder and select New > Component.
The Analytical Model Editor Dialog Box opens.
2. Enter the following details:
• Name: Reynolds Loss
• Description: Loss Using K v Re Curve
• Arm Connections: 2

October 2020
Catalogues
3. Click Edit Arms… to open the Component Connections Dialog Box and set the
connections as shown in the following image:
Figure 7-1. CAM Example—Component Connections
Click OK to close the dialog box and return to the Analytical Model Editor dialog box.
4. Click Add Existing…, add the following features, and configure them as described:
Table 7-9. Input and Output Features

Name Feature Type Necessity
Input Features
Diameter (Real) All Mandatory
Forward Loss Coefficient v (Curve or Equation)
Reynolds Number
Reverse Loss Coefficient (Real)
Output Features

October 2020
Catalogues
Table 7-9. Input and Output Features (cont.)

Name Feature Type Necessity
Pressure Drop (Real) Not Needed
Forward Loss Coefficient (Real)
Result
Results
The completed model details should look like this:
Figure 7-2. Completed CAM Example

Generating the Code Stub
The code stub is the file that contains the model definition for a CAM.
Prerequisites
• You must have fully defined the component analysis model; see Example: Creating a
CAM Using Performance Data - Creating the CAM.
• The model must be open in the Analytical Model Editor Dialog Box.
Procedure
1. Click Generate Code Stub… The Code Stub Generation Dialog Box opens.
2. Enter the following details:
• Namespace: HowTo.FlowmasterModels.Losses

October 2020
Catalogues
• Class Name: KvReLoss

• File Name: KvReLoss.cs
• Output Directory: enter the path to your Simcenter Flomaster programs folder
3. Select the interfaces to include from the Specify Inherited Interfaces list, as shown in the
following table:
Table 7-10. Generating the Code Stub—Interface Settings

Interface Description
Mandatory Interfaces
IcAnalysisPlugInConsumer Allows the component to access all of the other functions
available within the Simcenter Flomaster analysis
framework.
IcFormDataConsumer Allows the component to access items on component data
forms.
IcLinearCoeffs Allows the component to set the linear performance
coefficients that are used by Simcenter Flomaster to
calculate the component’s performance.
Advisable Interfaces
IcBranchResultConsumer Allows the component to access branch results, including
fluid pressure, hydraulic diameter, and fluid density to
calculate the linear coefficients.
IcInitialiseModel Allows the user to initialize models prior to the simulation.
IcResultProvider Allows the component to write results to the database.
4. Click Create File to create the code stub.

Creating a new Project and adding the Code Stub
Before you can edit a code stub, you must create a new project in which you can edit it.
Prerequisites
• You must have successfully created the code stub for the component analytical model;
see Example: Creating a CAM Using Performance Data - Generating the Code Stub.
• You must have installed and configured a suitable Visual C# editor.

October 2020
Catalogues
Note
The steps below refer to a generic Visual C# editor; you may need to adjust the
instructions for your own editor.
Procedure
1. Open your C# editor.
2. Select File > New Project to display the New Project dialog box.
3. Select the Class Library option and enter the name of the project. The name must be in
the format:
xxx.FlowmasterModels.xxx
Where xxx is a user-defined string. In this example, we call the class library:
HowTo.FlowmasterModels.Losses
4. Click OK to close the dialog box.
5. Add the code stub to the project by right-clicking in the Solution window and selecting
Add > Add Existing Item... to display the Add Existing Item dialog box.
6. Navigate to the Simcenter Flomaster programs folder and select the CAMHowTo.cs file.
7. Delete the Class1.cs file that was automatically created when you created the new
project.

Adding a Simcenter Flomaster Reference
To access the Simcenter Flomaster Interfaces, you must make a reference to the library
Flowmaster.Interfaces.dll.
Prerequisites
• You must have created a new C# project; see Example: Creating a CAM Using
Performance Data - Creating a new Project and adding the Code Stub.
Procedure
1. In your Visual C# editor, select Project > Add Reference. The Add Reference dialog
box is displayed.
2. Select the Browse tab, and then navigate to the Simcenter Flomaster programs folder.
3. Select Flowmaster.Interfaces.dll and click OK.

October 2020
Catalogues
Example: Creating a CAM using Performance Data -

Editing the Code Stub
You must configure a CAM before using it. You do this by editing the code stub.
• The first 70 lines of code, which contains the Globally Unique Identifier (GUID), should
not be edited.
The GUID is a long hexadecimal string, which is used by Simcenter Flomaster to
identify the component in a network. An example is shown below:
///<summary>The model’s identifier. DO NOT UPDATE.</summary>
private static Guid m_guidModel = new Guid(“fe983a9f-caea-48c7-b863-
a3805048de7a”);
Procedure
1. Update the Key Strings.
Simcenter Flomaster identifies the features to be read on the data form and the features
set in the results by using keys to identify the associated line number.
Tip
It is good practice to change the default names to something more meaningful.
The default code generated is:

public enum Key : short
{
//TODO: Rename the ‘Key’s to provide more sensible unique field
descriptions.
L1_1 = 1, // Diameter [Real;Input;Repeats=1]
L1_2 = 2, // Forward Loss coefficient v Reynolds Number [Curve or
Equation;Input;Repeats=1]
L1_3 = 3, // Reverse Loss Coefficient [Real;Input;Repeats=1]
L1_4 = 4, // Pressure Drop [Real;Output;Repeats=1]
L1_5 = 5, // Loss Coefficient Result [Real;Output;Repeats=1]
LastItem = 32767

October 2020
Catalogues
You need to change the L1_x statements to the names shown below:
public enum Key : short
{
//TODO: Rename the ‘Key’s to provide more sensible unique field
descriptions.
Dia = 1, // Diameter [Real;Input;Repeats=1]
ForwLossCurve = 2, // Forward Loss coefficient v Reynolds Number
[Curve or Equation;Input;Repeats=1]
RevK = 3, // Reverse Loss Coefficient [Real;Input;Repeats=1]
DeltaP = 4, // Pressure Drop [Real;Output;Repeats=1]
Calc_K = 5, // Loss Coefficient Result [Real;Output;Repeats=1]
LastItem = 32767
In the above, the key name Dia represents Diameter, ForwLossCurve represents the
Forward Loss Coefficient curve, RevK represents the Reverse Loss Coefficient, DeltaP
represents the Pressure Drop, and Calc_K represents the calculated loss coefficient that
is returned to Simcenter Flomaster.
2. Update the component name.
Change the component name string: This is name that is reported back to
Simcenter Flomaster to identify the component in error and warnings reports.
The default name is:
public string PlugInName
{
get { return “MyModelName”; } // TODO: rename
}
Change it to:
public string PlugInName
{
get { return “KvsReLoss”; } // TODO: rename
}
3. Initialize the Simcenter Flomaster Service Objects

October 2020
Catalogues
Initialize the service objects that provide services, such as the simulation status and
whether or not the simulation has converged. You do this by using the
InitialisePlugInConsumer section in the code, as shown below:
public void InitialisePlugInConsumer (IAnalysisGlblServices
services)
{
//TODO: Typically define member variables to provide access to
global services.
//staticprivate IAnalysisGlblServices m_Services =
null;
//staticprivate IgAnalysisStatusProvider m_AnalysisStatus =
null;
//staticprivate IgConvergenceCriteriaProviderm_ConvergenceCriteria
= null;
//staticprivate IgErrorHandlerProvider m_ErrHandler =
null;
// private IFluidPropertyProvider m_FluidProps =
null;
//m_Services = services;
//m_AnalysisStatus = services.AnalysisStatus;
//m_ConvergenceCriteria = services.ConvergenceCriteria;
//m_ErrHandler = services.ErrorHandler;
Move the member variables into the main program and initialize them and remove the
IFluidPropertyProvider provider (it is not required for this model). The modified code is
shown below:
static private IAnalysisGlblServices m_Services =
null;
static private IgAnalysisStatusProvider m_AnalysisStatus =
null;
static private IgConvergenceCriteriaProviderm_ConvergenceCriteria =
null;
static private IgErrorHandlerProvider m_ErrHandler =
null;
public void InitialisePlugInConsumer (IAnalysisGlblServices
services)
{
m_Services = services;
m_AnalysisStatus = services.AnalysisStatus;
m_ConvergenceCriteria = services.ConvergenceCriteria;
m_ErrHandler = services.ErrorHandler;
}
4. Initialize the Branch Result Consumer

The Branch Result Consumer enables you to access properties from the component
arms, such as pressure, mass flow, density, and so on.

October 2020
Catalogues
The default code is shown below:

public void InitialiseBranchResultConsumer (IiBranchResultProvider
brProvider)
{
//TODO Typically define a member variable to provide access to
the branch provider.
//private IiBranchResultProvider m_BrP = null;
//m_BrP = brProvider;
}
The updated code is shown below:

private IiBranchResultProvider m_BrP = null;
public void InitialiseBranchResultConsumer (IiBranchResultProvider
brProvider)
{
m_BrP = brProvider;
}
5. Set the Flow Area.

Return the area to the component using the GetFlowArea function.
Note
This step is only required for components which have an area.

public double GetFlowArea (int nArmNo)
{
return 0.0; // TODO: Return branch areas if known.
}
This code returns a value of 0. You must update this to calculate the area base of the
diameter from the data form.
The modified code is shown below:
public double GetFlowArea (int nArmNo)
{
//Calculate flow area from diameter
bool BIsSet;
double dia = m_DP.GetReal((short)Key.Dia,out BIsSet);
double area = Math.PI*(Math.Pow(dia,2.0));
return area; // TODO: Return branch areas if known.
}
The first line initializes a new Boolean variable called BIsSet. The second line makes
use of the m_DPobject created previously. This object enables you to access items on
the component data form.

October 2020
Catalogues
The GetReal function enables you to find the value of a “real” data form item. You
could use the variable number (1), or as you have done use Key.Dia, which picks-up the
key for diameter set earlier. The second parameter in the expression is a test as to
whether or not the value has been set. This returns the diameter from the data form. You
then calculate a new double-precision variable of “area” based on the diameter, using
the equation, and return this value.
6. Calculate and set the value of the Linear Coefficient.
You calculate and set the value of the linear coefficients in this model using the
PopulateMatrixSteady function, which is used in a Steady State simulation. By default,
the function is filled with comments, as shown below:
public void PopulateMatrixSteady(ref IMatrix matrix, ref IVector
vector)
{
// TODO: Update as appropriate
//double A1 = 1.234
//matrix.Set_Element(0,0, A1); // Simple coeffs for 2-arm loss
//matrix.Set_Element(0,1,-A1);
//matrix.Set_Element(1,0,-A1);
//matrix.Set_Element(1,1, A1);
//Crib Sheet
//bool bIsSet;
//double dArea = m_DP.GetReal((short)Key.Area, out bIsSet);
//double dK = m_DP.GetReal((short)Key.LossCoef, out bIsSet);
//BranchResultValue brMdot = this.m_BrP.GetBranchResult(1,
BranchResultType.MassFlowrate);
//BranchResultValue brRho =
this.m_BrP.GetBranchResult(1,BranchResultType.Density);
//double A1 = dK * brMdot.Value / (2.0 * brRho.Value * dArea *
dArea);
//A1 = - 1.0 / A1;
}

October 2020
Catalogues

public void PopulateMatrixSteady(ref IMatrix matrix, ref IVector
vector)
{
//dArea = branch area,dK = loss coefficient, bIsSet = boolean
//dAll values below for arm 2
//dMot - Mass Flow Rate, dRe - Reynolds Number, dDensity = Fluid
Number
bool bIsSet;
double dK,A1;
//Calculate flow area, read in mass flow, Re and density
double dArea = Math.PI *
Math.Pow(m_DP.GetReal((short)Key.Dia, out bIsSet), 2);
double dMot = m_BrP.GetBranchResult(1,
BranchResultType.MassFlowrate).Value;
double dRe = m_BrP.GetBranchResult(1,
BranchResultType.ReynoldsNumber).Value;
double dDensity = m_BrP.GetBranchResult(1,
BranchResultType.Density).Value;
// Check mfr for conditions first forward flow

if (dMdot >=0 //forward flow
{
ReadStatus CurveIsRead;
dK = m_DP.GetYfromX((short)Key.ForwardLossCurve, dRe, out
CurveIsRead);
A1 = dK * dMdot / (2 * dDensity * dArea * dArea);
A1 = -1.0 / A1;
}
else //reverse flow
{
dK = m_DP.GetReal((short)Key.RevK, out bIsSet);
A1 = dK * dMdot / (2 * dDensity * dArea * dArea);
A1 = 1.0 / A1;
}
//return the coefficients
matrix.Set_Element(0, 0, A1);
matrix.Set_Element(0, 1, -A1);
matrix.Set_Element(1, 0, -A1);
matrix.Set_Element(1, 1, A1);
vector.Set_Element(0, 0);
vector.Set_Element(1, 0);
}
The function operates as follows:

• Declare bIsSet , dK and A1
• Calculate the flow area
• Read the Mass Flow Rate, Reynolds Number, and the Density at branch 2.
• Check for forward flow.

October 2020
Catalogues
If there is forward flow:

i. Read the value of K from the curve of K v Re on the data form. This is done
using the GetYfromX function. The inputs to the function are the curve reference
(using Key.ForwardLossCurve), the value on the “X” axis (dRe) and whether or
not the curve is correct using the CurveIsRead function.
ii. Calculate the value of the A1 coefficient.
If there is reverse flow: then you:
i. Get the value K from the data form.
ii. Calculate the value of the A1 coefficient.
• Write the coefficients to the simulation matrix, using the matrix.Set_Element and the
vector.Set_Element functions.
7. Set the Transient Linear Coefficients.
As the component exhibits the same behavior in a transient simulation as in a steady
state, there is no need to write a new function to calculate results for transient
simulation. Instead, you can call the function used for the steady state. If different
transient behavior is required, this should be entered here.
public void PopulateMatrixTransient(ref IMatrix matrix, ref IVector
vector)
{
// TODO: Update as appropriate - see ‘PopulateMatrixSteady’
}

public void PopulateMatrixTransient(ref IMatrix matrix, ref IVector
vector)
{
PopulateMatrixSteady( ref matrix, ref vector);
}
This calls the PopulateMatrixSteady function that was created earlier.

8. Output the results.

October 2020
Catalogues
This step outputs the results. The default code is shown below:
public void WriteResults(IfComponentResultWriter writer)
{
// TODO: Update as appropriate
//double dMyResult = 1.0;
//double[] dMyResults = new double[] { 1.0. 2.0. 3.0 };
//writer.WriteResult( FF(MyResultKey}, new double[]
{dMyResult} );
//writer.WriteResult( FF(MyResultsKey), dMyResults);
}
Modify the code in order to output the loss coefficient and pressure loss results. The
modified code is as follows:
public void WriteResults(IComponentResultWriter writer)
{
double dP1 = m_BrP.GetBranchResult(0,
BranchResultType.TotalPressure).Value;
double dP2 = m_BrP.GetBranchResult(1,
BranchResultType.TotalPressure).Value;
double dDP = Math.Abs(dP1 - dP2);
writer.WriteResult(FF(Key.DeltaP), m_nComponentNumber, new
double[] { dDP }, false);
// calculate K
double dVelocity = m_BrP.GetBranchResult(1,
BranchResultType.Velocity).Value;
double dDensity = m_BrP.GetBranchResult(1,
BranchResultType.Density).Value;
double dK = Math.Abs((2 * dDP) / (dDensity * Math.Pow(dVelocity,
2)));
writer.WriteResult(FF(Key.Calc_K), m_nComponentNumber, new

double[] { dK }, false);
}
Here, you are using the Math.Abs function to ensure that the loss coefficient and
pressure drop are always reported as positive values. This ensures that the results are
reported correctly for reverse flow through the component.

Compiling the Code and Copying the .dll
When creating a CAM you must compile the code and then copy the .dll.
Prerequisites
• You must have correctly edited the code stub; see “Example: Creating a CAM using
Performance Data - Editing the Code Stub” on page 255 .

October 2020
Catalogues
Procedure
1. Right-click the solution and select Build.
Figure 7-3. CAM Example—Compiling the Code
Building the solution creates a new .dll called HowTo.FlowmasterModels.Losses in the

Releases folder for your solution. For example:
My Documents\Visual Studio 2008\Projects\HowTo.Flowmaster.Losses\
HowTo.FlowmasterModels.Losses\bin\Release
2. Copy the .dll to your Simcenter Flomaster programs folder. The default location is:
C:\Program Files (x86)\Simcenter\Flomaster

Creating and Customizing a Component
When creating a CAM you must create a catalogue in which to place it.

October 2020
Catalogues
Prerequisites
• You must have created the CAM; see Example: Creating a CAM Using Performance
Data - Creating the CAM.
• You must have created the code stub and edited the code; Example: Creating a CAM
Using Performance Data - Generating the Code Stub and Example: Creating a CAM
using Performance Data - Editing the Code Stub.
• You must have compiled the code and copied the created .dll into the
Simcenter Flomaster programs folder; see Example: Creating a CAM Using
Performance Data - Compiling the Code and Copying the .dll.
Procedure
1. From the Project View, on the Catalogues Tab, navigate to Flomaster > Components.
2. Right-click the User-defined catalogue, and select New Catalogue. A new catalogue is
created called New Catalogue Header1.
3. In the properties view edit the value of the Catalogue Header property and change the
name to one that suits the model you are creating. For example: My_New Components.
4. Right-click the new catalogue and select New > Component. The Selection from
Catalogue Dialog Box opens.
5. In the Browse Catalogues list, expand the Analytical Models folder and click the User-
defined folder to select it. The Filtered Items list updates to show the components in that
folder.
6. Select the Reynolds Loss model and then click Select… The component is added to the
catalogue as Customised Reynolds Loss and opened in the Component Customisation
Form.
7. Edit the Value field of the Custom Name property to change the name to
My_Reynolds_Loss.
8. Click the[...] button. The Selection from Catalogue Dialog Box opens.
9. Select the Filter All Catalogues option to see all the available symbols.
10. Select the Discrete Loss symbol and then click Select… The dialog box closes and the
symbol is displayed on the Component Customisation Form.
11. Click OK to save the component.

Using the Component in a Network
Use the new component in a simple network.

October 2020
Catalogues
Figure 7-4. Creating a CAM Using Performance Data - Example Network
Procedure
Input the component data.
Note
Only the component data that is required to be set is shown. All other data is set as
Default or NOTSET.
Table 7-11. Creating a CAM Using Performance Data - Component 1: Required

Data
Data Item Value Units
Cross-sectional Area 0.1 m2
Loss Coefficient 1 -

Data
Total Pressure 2 bar

Data
Total Pressure 1 bar

October 2020
Catalogues

Running a Simulation on the Test Network
Having built the test network, the next step is to run a simulation and make sure that there are no
errors in the initial input data.
Prerequisites
• You must have created a network, added the components, and specified the component
data. See Example: Creating a CAM using Performance Data - Editing the Code Stub
• The Network to simulate must be open in the Network window.
Procedure
1. In the Network View, click the Simulation Data Tab.
2. Set the value of the Simulation Type property to 1. Incompressible Steady State.
3. Click Run… As the simulation runs, a series of messages are displayed in the messages
area. If the simulation is successful, then a corresponding message is also displayed as
shown below.
Figure 7-5. Example Simulation Message
Results
Once the simulation has completed, click the Result Sets/Audit tab to see the results sets.
Double-click the required results set to load the results into the Data Form.

October 2020
Catalogues
Catalogues - Components
Catalogues - Components
The Simcenter Flomaster database comprises a range of components that can be used in
Compressible and Incompressible (Hydraulic and Non-hydraulic Power) applications. Each
component represents a mathematical model of an engineering component.
Note
For detailed information on any of the Simcenter Flomaster supplied components refer to
the Simcenter Flomaster Component Reference Manual.
Components are grouped into specific catalogues, and the catalogues that you see are dependent
upon the type of license you have. For example, if you have an Aerospace license, you will see
all the catalogues applicable to that license, but you will not see any catalogues that are specific
to another license type, such as Automotive or Gas Turbines.
Note
The paths of Catalogue folders, Analytical Models, Components, Materials, Performance
Data, Scripts, Sub-Systems, and Symbols are displayed in the Catalogue properties pane.

Customizing Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Component Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Composite Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Viewing Extended Properties for Components or Nodes. . . . . . . . . . . . . . . . . . . . . . . . . 290
Copy Features to Other Components and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Creating a New Component

You can create new, custom components based on the Simcenter Flomaster components.
• You must have a permission level which allows component creation.
Procedure
1. Open the Catalogues tab in the Project View pane.
2. Select the Components folder and then select New > Component from the right-hand
mouse button menu.

October 2020
Catalogues
Copying Components
The Selection from Catalogue Dialog Box dialog box is displayed.

3. Search for the required Analytical Model. See Searching the Database for more
information.
a. Select the required analytical model and close the search dialog box.
The component is added to the catalogue list as 'Customise: XXX: YYY' where 'XXX'
and 'YYY' are the catalogue name and the type of component (e.g. Bend:
MireRectangular), and the Component Customisation Form for the component is
displayed. From this form you can, if required, customize further the component.
Related Topics
Copying Components
Customizing Components
Copying Components
You can copy your own or Simcenter Flomaster components (to then customize and save as a
custom component).
Procedure
2. Open the catalogue containing the component that you want to copy and select it.
3. Select Copy from the right-hand mouse button menu.
The copy is added to the list as: 'Copy: XXX: YYY' where: 'XXX' and 'YYY' are the
catalogue name and the type of component (e.g. Loss: Discrete).
Related Topics
You can customize components to suit your requirements. You can only customize copies of
Simcenter Flomaster components or custom components (ones that have been added by
yourself or another user).

October 2020
Catalogues

Procedure
2. Click the component to display the Component Customisation Form.
Figure 7-6. Component Customisation Form
The form displays a list of all the component features. The feature’s properties are
displayed in the bottom pane.

October 2020
Catalogues
3. To modify a component:
Table 7-14. Modifying Components

To Do this
Give the model a custom 1. Click in the Custom Name field and enter a new name.
name (The purpose of
changing the Custom Name,
is so that you can distinguish
the component from the
Simcenter Flomaster
supplied components.)
Add custom help to the 1. Click in the Help and then click the [...] button
model 2. Click the button to display the Description dialog box.
3. Enter the details and then click OK.
Set the status Click in the adjacent cell to display a dropdown list and
select one of the following options:
Modify the connection Modify the Connection Type

placements and/or refine the 1. Click the Placements button. The Connection
signal type Placements dialog box is displayed.
2. To change a placement, click in the Placement field for
the connection you want to change and enter a new
value.
Refine the Signal Type
1. Click the Update button. The Update Connection
Details dialog box is displayed.
2. To change the Unit Quantity click the button. The
Unit Quantity Selector dialog box is displayed.
3. Select the required unit and then click OK.

October 2020
Catalogues
Table 7-14. Modifying Components (cont.)

To Do this
Hiding controller You can use the Hide setting to hide controller connections
connections on copies of components that you make. For example, you
may want to hide certain SI (Signal Inputs) and MO
(Measurement Outputs).
Note: You cannot hide fluid connections.
1. Click the Placements button. The Connection
Placements dialog box is displayed.
2. Uncheck the State check box for the required
connection.
3. Click OK.
Attaching a symbol to the 1. Click the Select Symbol button. The Selection from
component Catalogue dialog box is displayed with the symbols
catalogue (only) visible.
1. Select the required symbol and then click Select.
Set the results priority for 1. Select the required result (e.g. Pressure Drop) to display
selected output results the properties.
2. Click in the cell next to Results Priority to display the
following dropdown list:
3. Select the required option.

Add a descriptive sub- form 1. Right-click on the Descriptive Sub-Form entry (top,
left-hand pane) and select Add Descriptive Sub-form.
2. The Select Descriptive Sub-form dialog box is
displayed.
Modifying a Data Item
The following actions are relevant when modifying a selected data item. To see all the data
items associated with the model, click the + sign next to the model name. To modify a data
item, you must first select the one you want to modify.
Add custom help for 1. Select the required feature.
individual features 2. Click in the adjacent cell to expose a button as shown
below:
3. Click the button to display the Description dialog box.


October 2020
Catalogues

To Do this
Set the Auto. Apply Default Click in the value cell to display a dropdown list and select
action for a data item Yes or No
Apply a security level to a 1. Select the required feature.
feature 2. Click in the associated value cell to display a dropdown
list and select one of the following options:
Modify the Minimum and Set the Minimum and Maximum Values
Maximum values and • Click in the relevant value cell and set the required
associated unit quantities value.
Set the Unit Quantities
• Click the dropdown list which is displayed and select
the required units.
Modify the default value and Set the Default Value
its associated unit quantity 1. Click in associated value cell and enter the required
value.
2. Set the Default Value Unit Quantity
3. Click the dropdown list which is displayed and select
the required units.
Hiding selected features You can use the Hide option to hide features that are not
applicable to the component you are customizing. To do
this:
1. Select the required feature to display its properties.
2. Click in the cell next to Data Hide/Show to display a
dropdown list and select the required option.
Related Topics
Copying Components

October 2020
Catalogues
Component Templates
Component Templates
Component templates are representations of components that can be slotted into specific points
in a network. You can use these to create partially complete networks with the intention of
replacing the component template with a specific component at a later date.
When using component templates, you can define the connections, signal types, assign symbols,
and define what components can be used in place of the component template.In this case, when
using the network you can use the template’s dropdown list to select from the pre-defined range
of suitable replacement components.
Creating a New Component Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

Adding Allowed Analytical Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Adding Allowed Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Adding Output Results Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Showing a Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Creating a New Component Template

You can create your own component templates to be used when creating new components.
Procedure
1. With the Catalogues pane displayed, click the + sign next to the Simcenter Flomaster
entry to see all the catalogues.
2. Right-click on Components and choose the New Component Template option.
The Template Construction Quick Start dialog box is displayed. From this dialog box
you can:
• Decide whether or not you want to base your composite on one of the existing
Simcenter Flomaster Catalogues - Analytical Models.
• Allow only those components with identical signal ports to be included when you
select your Analytical Model
• Specify which components can be 'plugged' into the template.
Related Topics
Adding Allowed Analytical Models
Adding Allowed Components
Adding Output Results Features

October 2020
Catalogues
Component Templates

You can specify which Analytical Models that the template will access when placed in a
network.
Procedure
1. With the Component Template Editor dialog box displayed, click the associated Add
button.
The Selection from Catalogue dialog box is displayed.
2. Open the + sign next to Analytical Models and open the Simcenter Flomaster
Component Models entry to see all the available models.
3. Click on the required catalogue (e.g. Bends) to display the models.
4. Check the required model(s).
5. Click the Select... button to close the dialog box.
Results
The model is added to the list.
Related Topics

Add the Components that the template will access when placed in a network.
Procedure
1. With the Component Template Editor dialog box displayed, click the associated Add
button.
The Selection From Catalogue dialog box is displayed.
2. Click the + sign next to Components and open the required catalogue (e.g.
Incompressible) to see all the available components.
3. Click on the required catalogue (e.g. Controllers) to display the components in the right-
hand pane.
4. Check the required component(s) to select them.
5. Click the Select... button to close the dialog box.

October 2020
Catalogues
Component Templates
Results
The components are added to the list.
Related Topics

You can add a new output result feature to your component template.

October 2020
Catalogues
Component Templates
Procedure
1. With the Component Template Editor dialog box displayed, click the Add Existing
Output Feature button. The Feature Selection dialog box is displayed:
Figure 7-7. Feature Selection Dialog Box
The dialog box shows a list of features and its associated type (e.g. integer, real, curve,
equation or surface, etc).
To add a feature:
2. Search for a feature by entering a search term in the Find field.
For example, to search for all features starting with 'Minor', then enter 'Mino' in the field
and then click the Down or Up button to highlight the required feature.
3. Click the OK button.

October 2020
Catalogues
Component Templates
Results
The selected features are added to the Feature list in the Component Template Editor dialog
box.
Related Topics
Showing a Feature
You can set features to show or leave them hidden.
Procedure
1. With the Component Template Editor dialog box displayed, click the Show Selected
Feature button.
Depending on the type of feature selected, either the Integer or Real Feature dialog box
is displayed:
Figure 7-8. Integer Feature Dialog Box

October 2020
Catalogues
Component Templates
Figure 7-9. Real Feature Dialog Box
2. Select Input or Output to specify the feature type.

3. You can add text to help users of the template understand the features that you have
added. To do this click in the Help box.
4. For Real features, you can choose a Unit quantity. To do this:,
a. Click the [...] button to display the Unit Quantity Selector dialog box.
b. Select the required unit.
Note
You cannot set a Unit Quantity for Input features
5. Click OK to save the feature and close the dialog box.

October 2020
Catalogues
Composite Components
Composite components are individual components, that when connected together perform a
specific function when placed in a network. Any group of components can be made into a
composite component.
You could, for example, create a composite component that simulated a thermostat in an engine
cooling system. Once you have built the composite component, you can use it like any other
component.
Creating a Composite Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

Adding a Symbol to a Composite Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Deducing the Arms and Internal Circuits for a Composite Component . . . . . . . . . . . . 281
Adding Signals to the Composite Component. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Defining the Data Model for Composite Components . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Working with Composite Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Creating a Composite Component

You can create composite components - a component that contains two or more components
joined together. For example a component made of two Discrete Losses could then be used to
define an overall loss in a network.
• When you build a composite component, you must arrange for it to have connections to
the rest of the network. For example, you could include a Discrete Loss and leave one
end unconnected, or a component that has controller connections where another
component can connect to as shown below:
Figure 7-10. Composite Components - Example
Prerequisites
• It is recommended that you add a new sub-catalogue to the Components catalogue to
store any composites.

October 2020
Catalogues
Procedure
1. Right-click on the catalogue that you want to store the new composite in and select
New > Composite Component.
A Network Drawing window named Composite Component: New
Composite Component opens.
Rather than the Data, Experiments, Simulation Data, and Results Sets/Audit tabs present
when working with a network the Network View Pane contains tabs called:
• Data
• Data Model
• Connections
Figure 7-11. Building a Composite Component - The Network View Tabs
2. In the Project View pane, open the Components tab and navigate to the components
that you want to use to for the Composite Component. Add each one to the Drawing
Window.
3. Connect the components.
When sonnecting the first two components you will be asked to set the System
Connection Type Precedence.
4. Set the individual component data.
This definines the default values for the components.
5. Add a symbol to the composite. See Adding a Symbol to a Composite Component.
6. Deduce the number of arms and internal circuits. See Deducing the Arms and Internal
Circuits for a Composite Component.

October 2020
Catalogues
7. Create the relevant input signals to the composite and map them through to the
components comprising the composite. See Adding Signals to the Composite
Component.
Adding a Symbol to a Composite Component

When creating a new composite component you should add a symbol to the composite to aid
identification in the Network Drawing window.
When adding a symbol to a composite component you can choose one of the
Simcenter Flomaster supplied symbols or a custom symbol that you have previously created.
For detail of creating your own component symbols see “Creating New Symbols” on page 379.
Prerequisites
• If you are not already, ensure that you are in the Composite Component’s editing view
by right-clicking over the composite component and selecting the Edit Network option.
Procedure
1. In the Network View pane, click the Connections tab.
2. Click the Symbol button.
The Selection from Catalogue dialog box opens.
3. Open the catalogue to see all the entries. Open the required one to display all the
symbols in the right-hand pane.
4. Select the required symbol and then click the Select button.
Deducing the Arms and Internal Circuits for a Composite

Component
When you create a new composite component you must define the number of arms for the
composite.
Prerequisites
Procedure
1. In the Network View pane, click the Connections tab to display the Connections form.

October 2020
Catalogues
Figure 7-12. The Composite Component Connections Form
2. Click the Deduce... button to deduce the number of arms and internal circuits. The Arm
Mapping dialog box opens.
Figure 7-13. Composite Components - Arm Mapping Dialog Box
• Arm - shows the number of external arms (in this case 2).

October 2020
Catalogues
• Placement - Set placements according to the positioning of inputs and outputs of

your Composite Component.
• Part No and Part Arm No - Show the relationship between the components and the
connections.
In the example above we can see that Part No 1 (Component 1) is connected to Part
Arm 1 and Part No 2 (Component 2) is connected to Part Arm 2.
Note
Arm numbers are allocated automatically during the Deduce process and cannot be
edited.
The numbering of arms relates to the order in which the components are added to the
composite.

October 2020
Catalogues
Figure 7-14. Composide Components - Arm Mapping Examples

October 2020
Catalogues
Referring to Figure 7-14 in the top example, where the 4 loss components were added
sequentially from left to right (component numbers 1, 2, 3, and 4), the arms (marked A,
B, C, and D) have been assigned from left to right.
In the bottom example, where the 4 loss components were added non-sequentially
(component numbers 1, 3, 2, and 4), the arms (marked A, C, B, and D) have been
assigned in the order of the component addition.
3. Click OK to save the Arm mapping and close the dialog box.
Adding Signals to the Composite Component

When creating a new composite component you must add the signals that will map through to
the components comprising the composite.
Prerequisites
Procedure
1. In the Network View pane, click the Connections tab.
2. Click the Add... button. The Signal Mapping dialog box is displayed:
Figure 7-15. Composite Component - Signal Mappings Dialog Box

October 2020
Catalogues
3. To add the signals check the MO: Measurement Output item for the required
component.
The Signal Measurement Option dialog box is displayed:
Figure 7-16. Select Measurement Option Dialog Box
4. Select the a signal and then click OK.

Figure 7-17. Composite Components - Example of Signal Mapping
Note
You can edit the placements of signal connections by changing the placement
number.

October 2020
Catalogues
To see a graphical view of all the connections, click the Graphical View button:
Figure 7-18. Composite Component - Graphical Port Placement
Defining the Data Model for Composite Components

When you define the data model for a composite, you are defining an overall data form for it.
You need to this, because once you have placed the composite into a network, you cannot
access the individual data forms for the components that make-up the composite.
To define the data model for a composite component you:
1. Define the data form features for the composite (done in the same way as for Analytical
Models).
2. Specify the data items that are going to 'Fall Through', i.e. be passed-down to the
corresponding data item(s) for the components in the parts list.
For example, the feature 'Area' could be set to fall through to the components in the parts
list.
3. Specify the output results (e.g. Pressure Drop) tha tare going to be 'Passed-Up' from the
components in the parts list, to the corresponding output feature you have defined on the
overall data form.

October 2020
Catalogues
Prerequisites
Procedure
1. Click the Data tab to display the Data Model form.
Figure 7-19. The Data Model Form
The top pane shows the model name is used to create/edit the data form. From here you
can add a Descriptive Sub- form if required. The lower pane shows the parts list of all
the components comprising the composite. By clicking the required checkbox, you can
see the features for that component.

October 2020
Catalogues
2. Then:

To Do this
Create/Edit the data form 1. Click the Create/Edit button. The Analytical Model
Editor dialog box is displayed.
2. When you have finished defining the features, click
OK.
Add a descriptive sub form to To find out more about descriptive sub-forms see Feature
the model Types.
Set a data item to 'fall 1. In the top pane, click the + sign next to the model to see
through' to the corresponding all the features and select the required one.
data item(s) for the 2. Click the Check for Fall Thru radio button.
components in the parts list 3. If required, enter a scaling factor in the space provided.
4. In the bottom pane, click the + sign next to the required
component(s) to see all their features.
5. Select the required feature(s) by clicking their
associated check box(s).
Set a result output to 'pass up' 1. In the top pane, click the + sign next to the model to see
from the components in the all the features and select the required output feature.
parts list, to the 2. Select the Pass Up option.
corresponding output feature 3. In the bottom pane, click the + next to the required
defined on the overall data component(s) to see all their features.
form
4. Use the check boxes to select the required features.
Working with Composite Components

Composite components are individual components, that when connected together perform a
specific function when placed in a network. Any group of components can be made into a
composite component.
Once you have created a composite compoent (see “Creating a Composite Component” on
page 279, “Adding a Symbol to a Composite Component” on page 281,“Deducing the Arms
and Internal Circuits for a Composite Component” on page 281, “Adding Signals to the
Composite Component” on page 285, and “Defining the Data Model for Composite
Components” on page 287) you can use it in your networks.
Composite components act like other Simcenter Flomaster or custom created components. You
can select them from a catalogue, add them to your networks, and specify input data.

October 2020
Catalogues
Viewing Extended Properties for Components or Nodes
For a composite component you can:
• Open the Component Customisation Form by either :

o Double-clicking on the Composite Component in the Catalogue
o Right-clicking over the Composite Component in the Catalogue and selecting Edit
from the menu.
• Edit the underlying model by either:
o Right-clicking over the Composite Component in the Catalogue and select Edit
Network from the menu.
o For a Composite Component tha thas been added to a Network, right-clicking over
the component and selecting View Composite to open the Composite Component
editing view.
You can copy Composite Components.
From the Catalogue, right-click over the Composite Component:
• Select Copy to make a copy of the physical component but leave the underlying model
(the Composite Component’s underlying geometry, connections, and analytical models).
In this instance any modification of the anaylical model in the copy, will also affect the
original.
• Select Copy as New Composite to make a copy of the Composite Component including
the underlying analytical model.
In this instance any modification of the anaylical model in the copy will not affect the
original.
Viewing Extended Properties for Components or

Nodes
Extended Properties are properties that are not shown on data forms.
They include:
• The model name and associated description

• The component or node description
• Input/Output details
• Security details
• Descriptive Only details

October 2020
Catalogues
Viewing Extended Properties for Components or Nodes
• Unit Quantity details

• Min/Max limits
• Default settings.
You can view the Extended Properties for:
• Any component or node data item

• Any fluid data item
• Any sub-form data item.
Prerequisites
• Ensure that you have a network open.
• Ensure that you have collected the components and nodes.
Procedure
1. Select the required component or node.
2. Set the mode to Data and then click the Extended Properties button, . The
Extended Properties pane opens in the Network Drawing window:
Figure 7-20. The Extended Properties Pane
3. Select an item (e.g. Diameter) from the properties pane to display its extended
properties.
4. To see the properties for a sub-form (e.g. Visualiser and Segmenter Data):
a. Click in the adjacent cell to display a button. Click the button to display the sub-form
data.
b. Select the required item to display its extended properties.
5. The Custom and Model description fields show any attached descriptions. To see the
descriptions in more detail:
a. Click in the Value cells to display a button.

October 2020
Catalogues
Copy Features to Other Components and Nodes
b. Click the button to display the Description dialog box. When you have finished,
click the Close button.
6. Close the Extended Properties pane by clicking .

You can copy common features (e.g. length, diameter, curves, etc.) from one component to
another (of the same type component family). You can also copy features from one node to
another.
For example, if you had a network that contained a number of bends, say Mitre-Rectangular and
Mitre-Circular bends, you could set the Deflection Angle feature and then copy it to the other
bends.
Feature Matching
You use the Copy Features dialog box to copy features to other components.
Click the button to open the Copy Features dialog bx.
There are three methods of feature matching that you can use when copying features from one
component to another:
• Relaxed
• Strict
• Strict Component
Relaxed
With this option selected then all components with the same feature will be updated, regardless
of their type. For example, if you had a network that contained one Mitre-Rectangular and two
Mitre-Circular bends, and you wanted to update the Deflection Angle feature for all three bends,
then you would use this option.
Strict
With this option selected, then only those components of the same type and which have the
same feature will be updated.
For example, if you had a network that contained three Mitre-Rectangular and two Mitre-
Circular bends, and you only wanted to update the Deflection Angle feature for the three Mitre-
Rectangular bends you would use this option.
You would also use this option when you want to copy a sub-form feature from one component
to another. See Copying Features Across Sub-forms

October 2020
Catalogues
Strict Component
Use this option to copy features to:
• Components you have created that are based on an existing CAM.

• Copies of Simcenter Flomaster components that you have made.
For example the network shown below has three Bends (Mitre Circular components) and two
pressure sources.
Figure 7-21. Example Network
A copy was made of the Bend: Mitre Composite component and renamed 'MyBend: Circular
Mitre'. This component was then used for components four and five. Initially, the diameters for
these components were 0.49m and 0.39m respectively. The diameter for component five was
reset to 0.55m and the 'Strict Component' option was then used to apply the change. As a result,
the diameter for component four was found to be reset to 0.55m, but the diameter for component
3 remained unchanged.
Related Topics
Copying Features Across Sub-forms

October 2020
Catalogues

When copying features across sub-form, you can copy individual features as described above,
or you can copy the whole sub-form (for example copy the Piston/Slider Crank Data sub-form
data for the Primary Reference Data feature).
Procedure
1. Select the first component.
2. Click in the cell next to Primary Reference Data to display a button.
3. Click the button to display the top-level sub-form.
4. Click in the cell next to Piston/Slider Crank Data to display a button.
5. Click the button to display the associated features.
6. Set the required values and then click the Return button.
7. Click the check box next to Piston/Slider Crank Data and then click the button to
display the Copy Features dialog box.
8. Select the required Copy To option and then choose the Strict option.
9. Click OK.
Related Topics
Using the Multiple Edit Feature

The Multiple Edit Feature enables you to edit a feature (e.g. Diameter, Area, Level, etc), that is
common to a number of components and/or nodes. For example, if you had a network that
contained a number of Pipes, you could use this option to display the diameters for all those
components. You could then update the settings at the same time, rather than updating them on
an individual basis.
Prerequisites
• Ensure that the components or nodes that you want to share features are in a collection.
See Collecting and Filtering Component and Node Results
Procedure
1. In the Network Views pane, click the Data tab.
2. With the components and nodes displayed in the Collection List, select the required
component or node to display its properties.

October 2020
Catalogues
Using the Multiple Edit Feature
3. Select the required feature and then click the button. The view in the Properties pane
changes to show all the components or nodes with that feature. An example is shown
below:
Figure 7-22. The Properties Pane
In this example, you can see the values for all the nodes in the collection. To change a
value, click in the adjacent cell and enter the new value.
4. When you have finished, click the button to return to the normal view.

October 2020
Catalogues
Catalogues - Materials
Catalogues - Materials
Simcenter Flomaster contains a range of materials that you can use in your networks but you
can also create your own custom materials.
You can:
• Create a new material based on a Simcenter Flomaster supplied template - using this
method you can set the required values and performance data for each property.
• Create a new material template and then modify this to suit you requirements - using this
method, you can set the Min/Max values and units for each property, automatically
apply default values to properties, assign help to properties and assign a custom name to
the material.
• Create a completely new material by creating an Analytical Model that describes the
properties and features of a gas, liquid or solid. This method is the most complex and is
only recommended for use by experienced users.
For details about Analytical Models and how to create them see Catalogues - Analytical
Models
Create a New Material Based on a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Copying Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Materials Based On External Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Create a New Material Template

You can create your own material templates.
Note
It is recommended that, when creating new templates you add a new catalogue to the
Materials catalogue and use it to store custom materials.
Procedure
1. Open the Materials catalogue to display all the available entries.
2. Right-click on the catalogue and choose the New Material Template option. The
Selection from Catalogue dialog box is displayed.
3. Click the Material Templates entry to display the available templates.

October 2020
Catalogues
4. Select the required one (e.g. Standard Liquid) from the list and then click the Select
button. The template is added to the catalogue as Customise: Standard Liquid and the
associated Customisation form is displayed.
Figure 7-23. Creating a New Material Template - The Fluid Sub Form Dialog Box
5. Customize the material:
Table 7-16. Creating a New Material Template - Customizing a Material

Template
To Do this
Add a custom name 1. Click in the cell next to Custom Name.
2. Enter the Custom name.

October 2020
Catalogues

Template (cont.)
To Do this
Add custom help to the 1. Click in the Help value cell to display a button as shown
model below:

Set the status Click in the adjacent cell to display a dropdown list and
select one of the following options:
Modifying a Data Item

The following actions are relevant when modifying a selected data item. To see all the data
items associated with the model, click the + sign next to the model name. To modify a data
item, you must first select the one you want to modify. When you do this, its properties are
Add custom help for 1. Select the required feature.
individual features 2. Click in the adjacent cell to expose a button as shown
below:

Apply a security level to a 1. Select the required feature.
feature 2. Click in the associated value cell to display a dropdown
list and select one of the following options:
Set the Auto Apply Default Click in the value cell to display a dropdown list and select
action for a data item one of the following options:
• No
• Yes.

October 2020
Catalogues
Create a New Material Based on a Template

Template (cont.)
To Do this
Modify the default value and Set the Default Value for Eagle Ref. for Components 1-5
its associated units 1. Click in the associated value cell to expose a button.
2. Click the button to display the Eagle Option Fluid
dialog box.
3. Select the required option feature and then click OK.
Set the Default Value Unit Quantity for Other Features
1. Click in associated value cell and enter the required
value.
2. To set the units, click the dropdown list which is
displayed and select the required units.
Modify the Minimum and Set the Minimum and Maximum Values
Maximum values and 1. Click in the relevant value cell and set the required
associated units value.
2. Set the Unit Quantities
3. Click in the Minimum or Maximum value cell to
display a dropdown list and select the required unit
quantity.
Add a descriptive sub-form 1. Go to the top pane and right-click the Descriptive Sub-
Form entry.
2. Select the Add Descriptive Sub-form option. The
Select Descriptive Sub-form dialog box is displayed.
Related Topics

Simcenter Flomaster supplies a number of templates (models), which can be used as the basis
for materials that you want to develop.
The templates are:
• Simcenter Flomaster Classic Refrigerant Template

• GASPAK Fluid Template
• Humid Air
• NIST REFPROP 9.0 Fluid Template
• NIST REFPROP 9.0 Gas Template

October 2020
Catalogues
• NIST REFPROP 9.0 Liquid Template

• Refrigerant Equations Fluid Template
• Standard Gas Template
• Standard Liquid Template
• Standard Solid Template.
Note
When creating new materials, it is best practice to create a new sub-catalogue in the
relevant catalogue, and to create your new material there. In this way all of your
materials are kept separate from those supplied by Simcenter Flomaster
Procedure
2. Right-click on the new entry and choose the New Material option. The Selection from
Catalogue dialog box is displayed.
3. Click the Material Templates entry to display the templates.
4. Select the required template (e.g. Standard Liquid) and click the Select button.
Depending on the template selected, the new item is added to the catalogue as: 'New:
Fluid, Liquid, or Solid', etc.
5. To give the item a name, click it to display its properties in the bottom pane. Click in the
associated field cell and enter the name (e.g. My New Argon).
6. Select the new item to display its associated Material Property Data form.

October 2020
Catalogues
Figure 7-24. Creating a New Material based on a Template - The Material

Property Dialog Box
7. Set the material properties. See Setting the Materials Properties

Related Topics

October 2020
Catalogues
Setting the Materials Properties
Setting the Materials Properties

You can edit the properties of any custom (or copy of a Simcenter Flomaster) material.
Prerequisites
• Ensure that the Material Properties form for the Material that you want to edit is visible.
• You must have a permission set which allows the edit of material properties.
Procedure
Set the properties as below:
Table 7-17. Setting the Materials Properties

To Do this
Set a data item such as 1. Click in the Value cell alongside the data item and enter
Reference Temperature, the required value.
Ratio of Specific Heats, etc. 2. Click the dropdown list which is displayed and select
the required unit.
Set sub-form data (e.g. 1. Click in the Value cell alongside the data item to display
Material Title) a button.
2. Click the button. The view changes to show the sub-
form data.
3. Set the required data items.
Click the Return button to return to the main data form.
Set the Eagle Ref. for 1. Click in the Value cell alongside the data item to display
Component X sub-form data. a button.
2. Click the button. The Eagle Option Feature dialog box
is displayed.
3. Select the required feature and then click OK.
Set the required Equation of 1. Click in the Value cell alongside the data item to display
State (EOS) a dropdown list.
2. Select the required EOS.

October 2020
Catalogues
Copying Materials
Table 7-17. Setting the Materials Properties (cont.)

To Do this
Set a property such as the 1. Click in the Value cell alongside the data item to display
Vapour Pressure v T or two buttons.
Density v T curve etc. 2. Click the S.. button to display the Selection from
Catalogue dialog box, which enables you to search for
items in the database.
3. Once you have selected the required item, click the D..
button to display it.
For Fluid items, a dialog box is displayed which enables
you to set or view the relevant data items.
For Curves, Equations and Surfaces a Plot window is
displayed.
Copying Materials
You can copy any existing materials (either Simcenter Flomaster provided or custom).
Procedure
1. Click the Catalogues tab and then open the Materials catalogue.
2. Open the required catalogue (e.g. Incompressible, Hydraulic).
3. Select Copy from the right-hand mouse button menu.
A new copy of the material is created.

October 2020
Catalogues
Materials Based On External Standards

You can create materials based on the Eagle Fluids Database or by using the GASPAK fluids
program, and NIST Reference Fluid Thermodynamic and Transport Properties.
Materials Based On The Eagle Fluids Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
GASPAK. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Creating a GASPAK Fluid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Using the New GASPAK Fluid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
NIST REFPROP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Creating a New NIST REFPROP Fluid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Creating a New NIST REFPROP Gas or Liquid Material . . . . . . . . . . . . . . . . . . . . . . . . . 311
Creating a Fluid Based on a User Created NIST Data File . . . . . . . . . . . . . . . . . . . . . . . . 315
Defining a New NIST REFPROP Mixture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Using the New NIST REFPROP Fluid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Available NIST REFPROP Fluids and Refrigerants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
NIST REFPROP Fluids - Fluid Two Phase Properties Calculations . . . . . . . . . . . . . . . . . 322
Creating a New Fluid based on CAPE-OPEN Properties . . . . . . . . . . . . . . . . . . . . . . . . 323
Materials Based On The Eagle Fluids Database

You can use the Eagle database to create new materials.
If you intend to use the database, you should note the following points:
• The solution time is much longer when using the Eagle database. This is because the
solution time increases for each successive compound used in the fluid.
• The Eagle calculations for Nitrogen at low temperatures (-200 deg C) are erroneous.
• The Simple option can often be as accurate (unless you wish to model non-ideal gas
behavior).
When you create a new fluid, you can select up to five compounds (Eagle Ref for Component
1 - 5) to construct it. For each compound you select, you will also have to enter a corresponding
Mole fraction (or percentage present of the compound):
• The Redlich-Kwong-Soave (RKS) Equation of State.

• The London Research Station (LRS) Equation of State. This is an enhanced version of
the (RKS) Equation of State.

October 2020
Catalogues
GASPAK
You can create materials based on the GASPAK fluids program.
GASPAK © Cryodata Inc is a computer program for calculating the properties for different
fluids. The program uses fundamental state equations that are valid from the triple point and
melting line, through the saturation line and liquid-vapour mixtures, to high temperature and
pressure (the High T and P limits are different for each fluid).
To use GASPAK, you must purchase the GASPAK v3.41 Active X .dll which provides the
password that enables you to use GASPAK.
Note
Once you have obtained the .dll, you must place it together with the password text file
'AccessPassword.txt' and the GASPAK fluid coefficient files (*.gpk files) in main
Simcenter Flomaster program folder.
The following fluids are supported by GASPAK:

Table 7-18. GASPAK Fluids
Index No Fluid Index No Fluid
1 Ammonia 18 Neon
2 Argon 19 Nitrogen
3 Butane, iso 20 Nitrogen Trifluoride
4 Butane, normal 21 Oxygen
5 Carbon Dioxide, CO2 22 Propane
6 Carbon Monoxide CO 23 Water (above 273.16 K)
7 Deuterium 24 Xenon
8 Ethane 25 Refrigerant 11
9 Ethylene 26 Refrigerant 12
10 Helium 27 Refrigerant 22
11 Hydrogen, equilibrium 28 Refrigerant 32
12 Hydrogen, normal 29 Refrigerant 123
13 Hydrogen, ortho 30 Refrigerant 124
14 Hydrogen, para 31 Refrigerant 125
15 Hydrogen Sulphide 32 Refrigerant 134a
16 Krypton 33 Refrigerant 152a
17 Methane

October 2020
Catalogues
Creating a GASPAK Fluid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

Using the New GASPAK Fluid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Creating a GASPAK Fluid

You can create new materials based on the GASPAK fluid program.
Procedure
2. Select New Material from the right-hand mouse button menu option.
3. Select the GASPAK Fluid entry and then click the Select button. The new fluid is
added to the catalogue as: Customise: GASPAK Fluid. Also, its associated Component
Customisation Form is displayed.

October 2020
Catalogues
Figure 7-25. Creating a GASPAK material - The Component Customisation

Form - Example
4. To give the fluid a name, click the cell next to Custom Name and enter the new name.
5. To give the new fluid a description to help other users, click in the cell next to Custom
Help to expose a button. Click the button to display the Description dialog box and enter
the required details.
6. To assign a security level to the fluid, click in the cell next to Security Level and select
the required option.
7. Click in the cell next to Default Value to expose a dropdown list and select the required
fluid.
Using the New GASPAK Fluid

You can use a material created from the GASPAK program in networks.

October 2020
Catalogues
Prerequisites
• Open the network that you want to add the material to.
Procedure
1. Open theSimulation Data tab to display the simulation properties.
2. Click in the cell next to Default Materials to expose a button. Click the button to
display the associated sub- form.
3. Click in the cell next to Liquid Type to expose two buttons. Click the S... button to
display the Selection from Catalogue dialog box.
4. Search the database for the appropriate material and click OK to select it.

October 2020
Catalogues
NIST REFPROP
You can create materials based on NIST Reference Fluid Thermodynamic and Transport
Properties.
NIST REFPROP © is a computer program that calculates the properties for a range of Pure and
Pseudo-Pure fluids and Predefined mixtures.It uses the most accurate Equations Of State (EOS),
such as the Helmholtz EOS for water, refrigerants R134a, R32, and 143a. For older refrigerants,
such R14, R114, and RC318, it uses the Bender EOS. For the refrigerant R123, it uses the high
accuracy MBWR EOS.
There are several NIST REFPROP templates that you can use as the basis for your new fluid:
• NIST REFPROP Fluid Template

• NIST REFPROP Gas Template
• NIST REFPROP Liquid Template
These templates provide the following options for creating a fluid:
• Pure Fluid (Single Component)

• Pseudo-Pure Fluid
• Predefined Mixture
• Define New Mixture
• User Created NIST Data file
Creating a New NIST REFPROP Fluid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Creating a New NIST REFPROP Gas or Liquid Material . . . . . . . . . . . . . . . . . . . . . . . 311
Creating a Fluid Based on a User Created NIST Data File . . . . . . . . . . . . . . . . . . . . . . . 315
Defining a New NIST REFPROP Mixture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Using the New NIST REFPROP Fluid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Available NIST REFPROP Fluids and Refrigerants . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
NIST REFPROP Fluids - Fluid Two Phase Properties Calculations . . . . . . . . . . . . . . . 322
Creating a New NIST REFPROP Fluid

You can create fluid (material) based on the NIST REFPROP standards.
Procedure
2. Right-click over a Material catalogue and select New > Material from the menu.

October 2020
Catalogues

3. Select the NIST REFPROP Fluid Template.
4. You can specify a new name for the material by editing the Name field in the bottom
right-hand pane.
The default name is “new NIST REPFPROP Fluid Template”.
5. You can enter a description for the new material in the Description field in the bottom
right-hand pane.
6. Click the Select... button to create the new material.
The new material is created in the folder you highlighted in step 2.
7. Right-click the new fluid and select Edit from the menu.
The Material Property Data dialog box opens.
8. Assign a fluid to the new material.
You can assign:
• NIST REFPROP Pure Fluid
• NIST REFPROP Mixture Fluid
• User Defined Fluid
Note
It is recommended that you assign only one type. If you assign more than one, pure
fluids will take precedence over mixtures and mixtures will take precedence over
user defined fluids.
a. To assign a NIST REFPROP Pure or Mixture fluid, choose a fluid from the
appropriate dropdown list.
b. To assign a User Defined Fluid, click the[...] button in the Value field then specify a
Data File Type and a NIST REFPROP data file.
9. Click OK to save the changes and close the Material Property Data dialog box.
Results
The new material, with appropriate fluid data, is saved and updated in the folder you highlighted
in step 2.
Note
You can move the material to another folder by drag and drop.

October 2020
Catalogues
Creating a New NIST REFPROP Gas or Liquid Material

You can create materials (gas or liquids) based on the NIST REFPROP standards. These can be
a pure fluids (Single Component), pseudo-pure fluids, or pre-defined mixtures.
Procedure
2. Right-click over a Material catalogue and select New > Material from the menu.
3. Select either:
a. NIST REFPROP Gas Template
b. NIST REFPROP Liquid Template
4. Click the Select button to display the Select Fluid Type dialog box.
5. Enter the name of the new fluid, and then choose a fluid type from the Select Fluid
Type dropdown list.
6. Click the Preferences button to display the Calculation Mode Preferences dialog box.
Figure 7-26. Creating a New NIST REFPROP Material - Calculation Model
Preferences Dialog Box
7. Select the required Calculation Mode Option and click OK.

The Calculation Mode Preferences dialog box closes.
8. On the Select Fluid Type dialog box, click the Next>> button.
A dialog box containing the appropriate fluid types, based on your choice at step 5, is
displayed. The example below shows the dialog box presented for Pure Fluids.

October 2020
Catalogues
Figure 7-27. Creating a New NIST REFPROP Material - Pure Fluid (Single
Compounds) Dialog Box
9. Choose a fluid and then click the Next>> button to display the Pressure and
Temperature Conditions dialog box.

October 2020
Catalogues
Figure 7-28. Creating a New NIST REFPROP Material - Pressure and

Temperature Conditions Dialog Box - Example
10. Specify the pressure and temperature conditions that the fluid will operate over.
Tip
When defining the pressure and temperature conditions you can open the Fluid
Information dialog box by clicking the Fluid Info button. Here you will see
information about the fluid which you can copy and paste in to the Pressure and
Temperature Conditions dialog box.
11. Click Next>>.

The Pressure and Temperature Conditions dialog box closes, the Fluid Property Data
Generation Report dialog box opens, and the fluid creation begins.

October 2020
Catalogues
Figure 7-29. Creating a New NIST REFPROP Material - Fluid Property Data
Generation Report Dialog Box
The report shows any warning messages and gives details of the curves and surfaces that
are being generated.
You can stop the fluid creation by clicking the Abort button. Once creation is complete
the Abort button becomes a Finnish button.
12. Click the Finish button.
A message is displayed that shows where the curves and surfaces have been saved.
Usually: Performance Data/User Defined/NIST Fluid Data/XXXX
Where: XXXX is the name of the new fluid.
Results
The new material is created in the folder you highlighted in step 2.
Note
You can move the material to another folder by drag and drop.

October 2020
Catalogues
Creating a Fluid Based on a User Created NIST Data File

You can create materials (fluids) based on a user created NIST Data File.
Prerequisites
• Create a new NIST REFPROP fluid - see Creating a New NIST REFPROP Gas or
Liquid Material steps 1 - 4.
Procedure
1. With the Select Fluid Type dialog box open enter the name for the fluid, and then click
the dropdown list to choose the User Created NIST Data File option
2. Click the Preferences button to display the Calculation Model Preferences dialog box.
Select the required option and click OK.
3. Click the Next button to display the User Created NIST Data File dialog box.
4. Click the Browse button to display the Open dialog box and navigate to the required
location.
5. Select the required file and click OK.
6. Click the Next button to display the Pressure and Temperature Conditions dialog box.
7. Enter the pressure and temperature conditions for the fluid.
8. Click the Next button to display the Fluid Property Data Generation Report dialog box.
9. Once the process is complete, click the Finish button. A message is displayed showing
where the relevant curves and surfaces have been placed in the Catalogue structure.
Defining a New NIST REFPROP Mixture

You can create materials (fluids) based on a user created NIST Data File. You can also define
new NIST REFPROP mixtures.
When you define a new mixture you can select from a range of fluids and define the
compositions.
The following rules apply
• You can only mix fluids or gases. You cannot mix fluids with gases or vice versa.
Prerequisites
• Create a new NIST REFPROP fluid - see Creating a New NIST REFPROP Gas or
Liquid Material steps 1 - 4.

October 2020
Catalogues
Procedure
1. With the Select Fluid Type dialog box open, enter the name for the fluid, and then click
the dropdown list to choose the Define New Mixture option
2. Click the dropdown list to select either Mass Fraction or Mole Fraction.
3. To add a component:
a. Click the Add button to display the Select Fluid dialog box.
b. Select the fluid, and then click the Select button to add the component to the list.
c. Continue adding any additional components that you need by repeating steps
a and b.
d. Enter the compositions for each component by clicking the adjacent column and
entering the required values.
4. Click the Next button to display the Pressure and Temperature Conditions dialog box.
5. Enter the pressure and temperature conditions for the mixture.
6. Click the Next button to display the Fluid Property Data Generation Report dialog box.
7. Once the process is complete, click the Finish button. A message is displayed showing
where the relevant curves and surfaces have been placed in the Catalogue structure.
Using the New NIST REFPROP Fluid

You can create materials (fluids) based on a user created NIST Data File and use these in your
networks.
Prerequisites
• Ensure that the network that you want to add the fluid to is open.
Procedure
1. Click the Simulation Data tab to display the simulation properties.
2. Click in the cell next to Default Materials to expose a button. Click the button to
display the associated sub- form.
3. Click in the cell next to Liquid Type (for single phase liquids) or Two Phase Fluid
Type to expose two buttons. Click the S... button to display the Selection from
Catalogue.
4. Search for the required item, select it and click OK.

October 2020
Catalogues
Available NIST REFPROP Fluids and Refrigerants

When a NIST fluid is used (whether the fluid properties are directly or indirectly from Refprop),
the reference state for enthalpy and entropy is always the default reference state for the fluid.
The default fluid reference states are dependent on the fluids.
Table 7-19. NIST REFPROP 9.0 Pure Fluids
Fluid Fluid Name Reference Reference Notes
Number State State pressure
Temperature (bar)
(K)
1 Acetone 329.22 1.0131 NBP
2 Ammonia 300 0.01 OTH1
3 Argon 298.15 1.01325 OT02
4 Benzene 353.22 1.0134 NBP
5 Butane 273.15 1.0323 IIR
6 Butene 266.84 1.0131 NBP
7 Carbon monoxide 81.64 1.0135 NBP
8 Carbon sulfide 222.99 1.0133 NBP
9 Cis-butane 276.87 1.0133 NBP
10 Cyclohexane 353.886 1.0133 NBP
11 Cyclopropane 273.15 3.444 IIR
12 Decane 447.27 1.0132 NBP
13 Deuterium 23.661 1.0128 NBP
14 Dimethylether 248.368 1.0133 NBP
15 Dodecane 489.3 1.0098 NBP
16 Ethane 184.569 1.0133 NBP
17 Ethanol 351.57 1.0133 NBP
18 Ethylene 169.379 1.0133 NBP
19 Fluorine 85.0368 1.0133 NBP
20 Heavy water 374.563 1.0141 NBP
21 Helium 4.22 1.0113 NBP
22 Heptane 371.53 1.0132 NBP
23 Hexane 341.86 1.0131 NBP
24 Hydrogen 20.369 1.0133 NBP

October 2020
Catalogues
Table 7-19. NIST REFPROP 9.0 Pure Fluids (cont.)

Temperature (bar)
(K)
25 Hydrogen sulphide 212.85 1.013 NBP
26 Isobutane 273.15 1.5696 IIR
27 Isobutene 266.15 1.0114 NBP
28 Isohexane 333.36 1.0132 NBP
29 Isopentane 300.98 1.0134 NBP
30 Krypton 119.73 1.0129 NBP
31 Methane 111.667 1.0132 NBP
32 Methanol 337.632 1.0132 NBP
33 Neon 27.104 1.0131 NBP
34 Neopentane 282.65 1.0131 NBP
35 Nitrogen 298.15 1.01325 OT03
36 Nitrogen triflouride 144.138 1.0132 NBP
37 Nitrous oxide 184.68 1.013 NBP
38 Nonane 423.91 1.0132 NBP
39 Octane 398.77 1.0131 NBP
40 Oxygen 298.15 1.01325 OT04
41 Parahydrogen 20.271 1.0132 NBP
42 Pentane 309.21 1.0131 NBP
43 Perflurorobutane 271.061 1.0133 NBP
44 Perfluoropentane 302.904 1.0132 NBP
45 Propane 273.15 4.7446 IIR
46 Propylene 273.15 5.8409 IIR
47 Propyne 273.15 2.6493 IIR
48 R11 273.15 0.402 IIR
49 R113 273.15 0.1504 IIR
50 R114 273.15 0.8816 IIR
51 R115 273.15 4.4089 IIR

October 2020
Catalogues

Temperature (bar)
(K)
52 R116 273.15 18.4401 IIR
53 R12 273.15 3.0815 IIR
54 R123 273.15 0.3265 IIR
55 R124 273.15 1.6303 IIR
56 R125 273.15 6.7052 IIR
57 R13 273.15 19.6702 IIR
58 R134a 273.15 2.928 IIR
59 R14 300 0.01 OTH5
60 R141b 273.15 0.281 IIR
61 R142b 273.15 1.446 IIR
62 R143a 273.15 6.1967 IIR
63 R152a 273.15 2.6399 IIR
64 R21 273.15 0.7092 IIR
65 R218 273.15 4.1449 IIR
66 R22 273.15 4.9799 IIR
67 R227ea 273.15 1.9536 IIR
68 R23 273.15 24.947 IIR
69 R236ea 273.15 0.7826 IIR
70 R236fa 273.15 1.0776 IIR
71 R245ca 273.15 0.3413 IIR
72 R245fa 273.15 0.52922 IIR
73 R32 273.15 8.131 IIR
74 R365mfc 273.15 0.1845 IIR
75 R41 273.15 20.4361 IIR
76 Carbon dioxide 273.15 34.8514 IIR
77 RC318 273.15 1.2892 IIR
78 Sulfur dioxide 263.13 1.0132 NBP
79 Sulfur hexafluoride 273.15 12.5169 IIR

October 2020
Catalogues

Temperature (bar)
(K)
80 Toluene 383.75 1.0134 NBP
81 Trans-butene 274.03 1.0133 NBP
82 Trifluoroiodo methane 273.15 2.279 IIR
83 Water 300 0.01 OTH6
84 Xenon 165.05 1.0132 NBP
85 R1235yf 273.15 3.1582 IIR
86 Propylcyclohexane 429.9 1.0144 NBP
87 Cyclopentane 322.4 1.0133 NBP
88 D4 448.504 1.0133 NBP
89 D5 484.05 1.0132 NBP
90 D6 518.11 1.0133 NBP
91 Dimethyl carbonate 363.256 1.0132 NBP
92 MD2M 467.51 1.0133 NBP
93 MD3M 503.02 1.0132 NBP
94 MD4M 533.9 1.04 NBP
95 MDM 425.66 1.0128 NBP
96 Methyl linoleate 628.84 1.0132 NBP
97 Methyl linolenate 629.13 1.0133 NBP
98 MM 373.401 1.0133 NBP
99 Methyl oleate 627.18 1.0133 NBP
100 Methyl palminate 602.3 1.0139 NBP
101 Methyl stearate 629.56 1.0133 NBP
102 Orthohydrogen 20.38 1.0133 NBP
103 R1234ze 273.15 2.1655 IIR
104 R161 273.15 4.3742 IIR
105 Methylcyclohexane 374 1.013 NBP
106 Undecane 468.934 1.0132 NBP
107 Diethyl ether 307.604 1.0132 NBP

October 2020
Catalogues

Temperature (bar)
(K)
108 Ebenzene 409.314 1.0132 NBP
109 Hydrogen chloride 188.199 1.0133 NBP
110 Isooctane 372.358 1.0132 NBP
111 M-xylene 412.214 1.0133 NBP
112 Novec6499 273.15 0.1246 IIR
113 O-xylene 417.521 1.0133 NBP
114 P-xylene 411.47 1.0132 NBP
115 R1216 273.15 3.3621 IIR
116 R1233ZD 273.15 0.4786 IIR
117 R40 249.173 1.0133 NBP
118 RE143A 273.15 2.5664 IIR
119 RE245CB2 273.15 0.8072 IIR
120 RE245FA2 273.15 0.2896 IIR
121 RE347MCC 273.15 0.2404 IIR
1. Enthalpy and entropy specified at reference temperature and pressure (real gas state): Enthalpy: 1699.664
kJ/kg, Entropy: 9.356 kJ/kg-K
2. Enthalpy and entropy specified at reference temperature and pressure (ideal gas state): Enthalpy: 154.933
Where
• NBP - The enthalpy and entropy are set to 0 at the normal boiling (reference temperature
and pressure) point.
• IIR -The enthalpy is set to 200 kJ / kg and entropy is set to 1.0 kJ/kg-K for saturated
liquid at 273.15 K.

October 2020
Catalogues
• OTH - The enthalpy and entropy are set to the specified values (dependent on fluids) at
the reference temperature and pressure (real gas state).
• OT0 - The enthalpy and entropy are set at the specified values (dependent on fluids) at
the reference temperature and pressure (ideal gas state).
NIST REFPROP Fluids - Fluid Two Phase Properties Calculations

The Simcenter Flomaster equations for calculation of the two phase properties for NIST
REFPROP fluids.
Note
The following equations are applicable when quality is in between 0 and 1. In all cases: x is
the quality, subscript L denotes a liquid phase property, and subscript V denotes a vapour
phase property.
Density
(7-12)
Compressibility Factor
(7-13)
Enthalpy
(7-14)
Entropy
(7-15)

October 2020
Catalogues
Viscosity
(7-16)
Specific Heat
(7-17)
Conductivity
(7-18)
Bulk Modulus
(7-19)
Creating a New Fluid based on CAPE-OPEN Properties

You can create Simcenter Flomaster materials based on third-party data that has been developed
to CAPE-OPEN standards.
Prerequisites
• You must have previously installed at least one CAPE-OPEN Property Package.
Procedure
1. From the Flomaster Launchpad, open the Material Group and choose New CAPE-
OPEN fluid.

October 2020
Catalogues
The CAPE-OPEN Fluid Creation dialog opens.
2. In the left-hand pane:

a. Type a name for the new fluid in the Fluid Name field.
b. Use the Fluid Type dropdown list to specify that the new fluid is either Compressible
or Incompressible.
c. You can specify where the new fluid is created by using the Material Path field.
The default location is Catalogues > Materials > User-defined.
d. Use the Available Property Packages dropdown list to choose a package and then
choose the fluids and their ratios using the Available Fluids dropdown list.
Note
Some packages require you to specify other parameters when setting up the new
fluid. For example, when using the TEA (CAPE-OPEN 1.1) package you must
also specify the Fraction Type. In these instances the ‘CAPE-OPEN Fluid Creation’
dialog will present the options that you must set.

October 2020
Catalogues
3. In the right-hand pane:

a. Use the Pressure Limits (bar) fields to specify minimum and maximum pressure
limits.
b. Use the Temperature Limits (oC) fields to specify minimum and maximum
temperature limits.
c. You can view the tolerances of the fluid properties at any time by clicking the Fluid
Property Tolerances button.
A table displaying the data is shown.
You can sort the data according to values by clicking on the appropriate heading.
d. You can view fluid information for all available fluids that you chose in step d by
clicking the Fluid Info button.

October 2020
Catalogues
A table displaying the data is shown.
You can sort the data according to values by clicking on the appropriate heading.
4. Click the GENERATE... button to generate all the curves and surfaces over the ranges
that you specified for the new fluid.
Information about the fluid being generated, such as details of any properties required
by Simcenter Flomaster which are absent in the CAPE-OPEN Property Package, are
displayed.
Once complete, a 'Fluid generation is successful' message is displayed.

5. Click the CREATE button.

October 2020
Catalogues
Results
Simcenter Flomaster switches to the Network view, the Catalogues tab in the Project View is
selected, the catalogue tree is open at the location you specified in step c, and the new fluid is
selected. The Material Property Data dialog for the new fluid is open.
Before using the new fluid you should review all properties and their values and, for any
mandatory properties that were not populated with data during the generate process, provide the
appropriate data.

October 2020
Catalogues
Catalogues - Performance Data
Catalogues - Performance Data

The Performance Data catalogue is used to hold the supplied Simcenter Flomaster data, which
includes 2D and 3D equations, Curves, and Surfaces.
Note
You cannot edit the supplied Simcenter Flomaster performance data. But you can make a
copy of an item and then modify it to suit your requirements.

Displaying Performance Data as Plots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Creating New Nusselt Surfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Copying Performance Data

Simcenter Flomaster contains a range of performance data items which you can use in your
networks. You cannot edit these items but you can make copies to edit (or create your own
custom items).
You can create/copy:
• Curves
• Surfaces
• 2D and 3D Equations
• Special features such as:
o Pump Head and Torque Curves
o Loss Curves
o Nusselt Surfaces
o Flow Coefficient Curves
• FloEFD Curves and surfaces
Procedure
1. Click the Catalogues tab and then open the Performance Data catalogue.

October 2020
Catalogues
Displaying Performance Data as Plots
2. Open the required catalogue (e.g. Bends) to see all the associated items.
3. Right-click on the required item and choose the Copy option.
a. The item is added to the list as Copy: xxx where xxx is the original performance data
item name.
Note
You are advised to rename the copy so that you can distinguish it from those items
supplied by Simcenter Flomaster.

You can display performance data as plots.
Procedure
1. Click on the required catalogue (e.g. Bends) to see all the associated curves, equations
and surfaces.
2. Right-click on the item you want to view and choose the View option. The Plot Window
is displayed.

October 2020
Catalogues
Figure 7-30. Displaying Performance Data as Plots - The 2D Performance Plot

Window

October 2020
Catalogues
Figure 7-31. Displaying Performance Data as Plots - The 3D Performance Plot

Window
3. For 2D plots you can plot multiple performance data items on the same chart:
a. Click the button.
b. Right-click on the second curve you want to view and choose the View.
The plot is added to the window.
4. You can save, print, and export plots as an image using the plot window’s toolbar
buttons. For 3D plots you can also orientate the surface.

October 2020
Catalogues
Creating New Curves and Surfaces

There are two steps to creating new curves and surfaces, creation of the item itself and then
creation of the performance data.
Note
It may be more efficient, if a suitable item is available, to copy an existing curve or surface
and edit it.
See “Copying Performance Data” on page 328.
Creating a Curve or Surface Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

Adding Performance Data to a Curve Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Adding Performance Data to a Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Table Value Scaling Function Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Chebyshev Coefficients Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Chebyshev Coefficient Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Creating a Curve or Surface Element

You can create new curve and surface performance data items.
Procedure
1. Either:
a. Right-click on the folder where you want to create the new curve or surface and
select New > Curve or New > Surface
a. From the Performance Data group on the Launchpad click New Curve or New
Surface.
The Launchpad closes and the select Path dialog boxis displayed.
b. Select a location to store the new element and click OK.
The Curve or Surface dialog box opens.
2. Set the properties:
Table 7-20. Creating a Curve or Surface - Entering and Amending the Curve
Data
Add a curve or Click in the Title box and enter a title.
surface title

October 2020
Catalogues
Table 7-20. Creating a Curve or Surface - Entering and Amending the Curve
Data (cont.)
Add your own help 1. Click the button in the Help field to display the Description
details for the curve dialog box.
or surface 2. Enter the help details in the text box and then click OK.
Add axis titles Click in the relevant Axis Title value cell and add the title.
Add axis units 1. Click the button in the Axis Unit field to display the Unit
Quantiy Selector dialog box.
2. Select the required unit quantity and then click OK.
Note: The Unit Symbol field is automatically populated
when a unit is selected. For quantities where more than one
unit is available you can select the unit symbol from the Unit
Symbol dropdown list.
Set the axis scales Click in the relevant Axis Scale value cell to display a dropdown
list and select either Linear or Logarithmic.
Note: there are only two axes (X and Y) for curves but three (X, Y, and Z) for surfaces.
Results
The new curve or surface is created. To use the curve or surface you must add some
performance data to it. See “Adding Performance Data to a Curve Element” on page 333.
Adding Performance Data to a Curve Element

You must add performance data to any newly created curve elements before you use them.
Prerequisites
• You must have created a new curve. See “Creating a Curve or Surface Element” on
page 332
Procedure
1. Navigate to the curve that you want to add performance data to and double-click it to
open the Curve dialog box.
2. Either:
a. Enter values for the X and Y axes in the Performance Data table.
Tip
You can paste data in to this table from a text or CSV file.

October 2020
Catalogues
As you add values to the table they are displayed in the plot window on the right-
hand side of the Curve dialog box.
a. Click Digitize.
The Curve Digitizer dialog box opens.
If you have previously specified the X and Y axes Quantities, Units, and Scale (see
step 2 in “Creating a Curve or Surface Element” on page 332) these will be
automatically populated in the appropriate fields on the Curve Digitizer Axis
Definition tab. If not, you can use the dropdown list to set these.
b. Click Import Image.
The Select Image dialog box opens.
c. Navigate to the folder where the image is stored, select it and click Open.
Note
You can import PNG, GIF, JPG, or BMP files
The imported curve is displayed on the right-hand side of the Curve Digitizer dialog
box.
d. Use the appropriate fields to enter values for:
o X Maximum - The maximum x axis value on the image that you imported.
o X Origin - The maximum x axis value on the image that you imported.
o Y Maximum - The maximum y axis value on the image that you imported.
o Y Origin - The maximum y axis value on the image that you imported.
e. By clicking on the image you imported, specify:
i. The maximum value on the x axis
ii. The origin
iii. The maximum value on the y axis
Note
You must define these points in the order listed above. Once you have correctly
set these values the Coordinates Definition tab becomes active.
f. Select the Coordinates Definition tab.

g. Add points to the X Y table by clicking on the imported curve image.
Points are added to the X Y table in X value order.

October 2020
Catalogues
You can delete any points by selecting the row in the X Y table and pressing the
Delete key.
The more points that you add the closer the Simcenter Flomaster performance curve
will be to the image. Pay close attention to changes in the curve's direction or rate of
change.
The Define Axis button removes all points from the image, clears the current X Y
table, and returns you to the Axis Definition Tab.
h. Click Save to close the Curve Digitizer dialog box.
The Curve dialog box now shows the populated performance data in the
Performance Data table.
3. You can scale the x or y values by using the Factor Data... button (see Table Value
Scaling Function Dialog Box)
Note
You can edit the values in the performance data table. You can delete rows by
selecting them and using the Delete key. The curve in the right-hand pane is
automatically updated with any edits or deletions.
4. Apply a mathematical fit line to the data by choosing an option from the Degree Fit
dropdown. Select either:
• 99. Automatic - Simcenter Flomaster will pick the best-fit polynomial curve for the
data
• 0. Linear Intrp. - Simcenter Flomaster will apply the best-fit straight line through the
data points
• One of the 19 polynomial curves.
The degree fit line is displayed on the curve.
5. To check for errors in the degree fit line, click the View Coeffs... button. The Chebyshev
Coefficients Dialog Box is displayed.
6. Click OK to save and close the Curve dialog box.
Adding Performance Data to a Surface

You must add performance data to any newly created surfaces before you use them.
Prerequisites
• You must have created a new surface. See “Creating a Curve or Surface Element” on
page 332

October 2020
Catalogues
Procedure
1. Navigate to the surface that you want to add performance data to and double-click it to
open the Surface dialog box.
2. Enter values for the X, Y, and Z axes in the Performance Data table.
Tip
As you add values to the table they are displayed in the plot window on the right-hand
side of the Surface dialog box.
3. You can scale the x, y, or z values by using the Factor Data... button (see Table Value
Scaling Function Dialog Box)
Note
data
data points
• 1. Delauney Triangulation - A mathematical model for creating a mesh of triangle-
based polygons for a set of 3D points.
Note
This fit type may be unsuitable for data which describes a surface in high
resolution, in these instances selecting this option will display an error message
indicating that linear interpolation fit will be used instead.
• One of the polynomial curves.

6. Click OK to save and close the Surface dialog box.

October 2020
Catalogues
Table Value Scaling Function Dialog Box

To access: Click Factor Data... from the Curve or Surface dialog box.
Used to apply a scaling factor to curves and surfaces.
Figure 7-32. The Table Value Scaling Function Dialog Box
Objects
The Help panel shows you how the scaling factor should be entered in the bottom pane.

October 2020
Catalogues
Chebyshev Coefficients Dialog Box

To access: For any Logarithmic curve or surface click View Coeffs... from the Curve or Surface
dialog box.
Used to view the Chebyshev Polynomial Coefficients.
Figure 7-33. Chebyshev Polynomial Coefficient
Objects
The Polynomial Fitting Coefficients shows the coefficients, the RMS Errors for Degree of Fit
shows the RMS errors.
Related Topics
Chebyshev Coefficient Definitions
Chebyshev Coefficient Definitions

Simcenter Flomaster contains definitions of the Chebyshev Coefficients.

October 2020
Catalogues
For 'n' degree of fitting:
(7-20)
Note
T(1,0) = T1(xx)*T0(yy)T(1,1) = T1(xx)*T1(yy) etc
ID = 0.5n2 + 1.5 n+1
Where:
Tj + 1(yy) = 2.yy. Tj (yy) - Tj - 1 (yy)
T1 (yy) = yy
T0 (yy) =1
yy = (2* y - (ay + by)) / (by - ay)
ay = lower limit of y
by = upper limit of y
Ti + 1(xx) = 2.xx. Ti (xx) - Ti - 1 (xx)
T1 (xx) = xx
T0 (xx) =1
xx = (2* x - (ax + bx)) / (bx - ax)
ax = lower limit of x
bx = upper limit of x
Cij = Coefficient ((j - 1)* k + 1)

October 2020
Catalogues
Examples
Examples for different degrees of fit:
2 Degree Fitting
(7-21)
3 Degree Fitting
(7-22)
4 Degree Fitting
(7-23)
Related Topics
Chebyshev Coefficients Dialog Box

October 2020
Catalogues
Equations
Equations
Simcenter Flomaster contains a range of equations suitable for many applications but you can
also add your own (or make a copy of an existing equation and then edit it to suit your
requirements).
Creating Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Equation Cutoff Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Creating Equations
You can create new 2D and 3D equations.
Procedure
1. Either:
a. Right-click on the folder where you want to create the new equation or surface and
select either New > 2D Equation or New > 3D Equation
a. From the Performance Data group on the Launchpad click 2D Equation or
3D Equation.
The Launchpad closes and the Select Path dialog box is displayed.
b. Select a location to store the new equation and click OK.
The 2D or 3D Equation dialog box opens.
Table 7-21. Creating Equations - Entering and Amending the Equation Data
Add a title Click in the Title box and enter the a title.
or surface 2. Enter the help details in the text box and then click OK.
Add axis titles Click in the relevant Axis Title cell and add the title.
Add axis units 1. Click the button in the Axis Unit field to display the Unit
Quantiy Selector dialog box.
2. Select the required unit quantity and then click OK.
Set the axis scales 1. Click in the relevant Axis Scale value cell to display a
dropdown list and select either Linear or Logarithmic.
Note: there are only two axes (X and Y) for 2D equations but three (X, Y, and Z) for
3D equations.

October 2020
Catalogues
Equations
Set the x minimum 1. Click in the X Minimum box and enter a value.
and x maximum The unit is automatically populated.
values
For quantities where more than one unit is available choose a
unit from the dropdown list.
2. Repeat step 1 for X Maximum.
Note: For 3D equations you must also specify the y minimum
and y maximum values.
For information on the maximum and minimum values see
“Equation Cutoff Values” on page 342
Enter the equation Click in the Equation Data window and enter the equation data in
data the form shown:
Note: Equations can only be entered in C#.

Compile the equation Check the Proceed option.
The compiled equation is displayed in the right-hand pane.
Check the equation Click the Syntax Editor button to display the Script and Plug-In
syntax Editor dialog box.
Equation Cutoff Values

You can determine the points between which an equation is operative by specifying maximum
and minimum values for certain axes.
For 2D equations you can specify the maximum and minimum values for the x axis. For 3D
equations you can specify the maximum and minimum values for the x and y axes.
Outside these maximum and minimum values data is extrapolated or set to the value at the limit.
Which method you use depends on the intended use of the equation.

October 2020
Catalogues
Equations
Figure 7-34. The X and Y Cut Off Values

October 2020
Catalogues
Creating Pump Curves

Simcenter Flomaster pump components contain performance data (curves) that suit a variety of
applications but you can, if required, provide your own curve data.
You can create Pump Head and Pump Torque curves. For both types you can either:
• Input a new curve, in which case you define the axes (e.g. add label names, set the Min,
Max limits, etc) and the data.
• Make a copy of an existing curve, in which case the data is displayed against fixed axes.
These axes can then be, along with other data, changed and the new curve saved.
When creating a new curve, the data can be input or modified in a manner chosen to suit the
data available. For example:
• Actual Values - Curves of head (or pressure), torque, power, or efficiency as functions
of flow rate, at a constant speed.
• Normalized (Conventional) - Curves normalized with respect to 'Best Efficiency Point'
values.
• Suter Parameter - Pump data capable of describing (subject to certain assumptions) the
performance of a pump at all speeds and flow rates (including negative values of both or
either). This form allows the behavior of a pump during speed reversal to be described.
Inputting Pump Curves - Worked Example
Choosing the Correct Form of Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Creating Pump Head Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Inputting Pump Curves - Worked Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Creating Pump Torque Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Creating a Pump Torque Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Adding Performance Data to a Pump Torque Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Choosing the Correct Form of Input

Your own pump curve data must be in a form consistent with Simcenter Flomaster’s
requirements.
Most manufacturers only supply data for the normal operating region of the pump, that is from
shut valve (zero flow) to about 1½ or 2 times rated (B.E.P.) flow. A curve input this way is
suitable for Steady State or Flow Balancing, and Transient analyses where reverse flow and/or
pump speed reversal cannot occur.
In other cases, you must estimate the performance of the pump in other regions of operation.
Standard curves are provided for '4 quadrant' performance of the three major classifications of

October 2020
Catalogues
pump type. The recommended method of inputting this data is to use the ¾ copy option to make
a copy of one of the existing pump curves that best fits your requirements.
Pump curves contain data for forward and reverse operation. When you make a ¾ copy, the
whole of the reverse speed curve is copied, but only ¾ (or three quadrants) of the forward speed
curve. You can then input the data for the missing quadrant, i.e., the normal operating region for
which data is readily available.
See “Inputting Pump Curves - Worked Example” on page 347 for more details on the ¾ copy
option,
Three pumps with known characteristics in all four operating regions are supplied in
Simcenter Flomaster. To choose the most appropriate when making a ¾ copy try to match the
specific speed, Ns, as closely as possible.
(7-24)
Where:
N = Speed (rpm)
Q = Corresponding flow (per entry) at Best Efficiency Point (m3 s-1)
H = Corresponding head (per stage) at Best Efficiency Point (m)
Creating Pump Head Curves

You can use the Pump Head Curve wizard to create new pump head curves.
Procedure
1. Either:
a. Right-click on the folder where you want to create the new Pump Head Curve and
select New > Special Features > Pump Head Curve.
a. From the Performance Data group on the Launchpad click New Pump Head Curve.
The Launchpad closes and the select Path dialog box is displayed.
b. Choose a location to store the new curve and click OK.
The Pump Head Curve wizard opens.
2. Enter a name for the Pump Head Curve by editing the text in the Name field.

October 2020
Catalogues
Note
The default name is New Pump Head Curve. You cannot use the wizard to create a
curve with the same name as a curve that already exists in that folder.
3. Enter values for Rated Flow, Rated Head and Rated Speed.
4. Click the Enter Curve button.
5. You can use the wizard to enter data as actual or suter values.
a. To add data as Actual Values, ensure that the Actual Values tab on the graph on the
right-hand side of the Curve Entry page is selected.
b. Add data to the Flow <m3/s>, Head <m>, and Rotation Direction fields of the
table on the left-hand side of the Curve Entry page.
a. To add data as suter values, ensure that the Suter Values tab on the graph on the
right-hand side of the Curve Entry page is selected.
b. Add data to the Theta <rad> and Suter Head Parameter <normalized> fields of
the table on the left-hand side of the Curve Entry page.
The graphs and tables for both actual and suter values are automatically updated as you
enter data into either table.
Tip
You can delete rows by selecting them and using the Delete key.
6. Extend All Operational Modes

This option allows you to create fully defined curves with only limited data. Simcenter
Flomaster does this by using the Specific Speed, calculated based on the rated
conditions you entered in step 5, to select the most appropriate curve from the following
standard curves:
• 0-110 – Radial
• 110-200 Mixed
• >200 Axial
Any curve data that you entered (in step 5) where both:
• Where the y value on the suter plot is positive
• The x value is less than π/2
replaces that of the standard curve.
This gives a fully defined curve for all quadrants of pump operation

October 2020
Catalogues
7. Apply a fit line to the data by selecting an option from the Degree Fit dropdown menu.
Select either:
• Automatic Fit - Simcenter Flomaster will pick the best-fit polynomial curve for the
data
• Linear Interpolation - Simcenter Flomaster will apply the best-fit straight line
through the data points
8. Click Save to close the wizard and create the new Pump Head Curve.
Note
The Pump Head Curve wizard is only available when creating new Pump Head
Curves. You can edit any previously created Pump Head Curve by double-clicking
the item to open the Curve dialog box.
Inputting Pump Curves - Worked Example

This example shows you how to input a pump curve using the ¾ copy option.
The ¾ copy option copies 3 quadrants of a known curve and you input the missing fourth
quadrant. In this example it is assumed that you have data for the positive head/flow quadrant
only.
The following data is available, at a speed of 2,900 r.p.m.:

Table 7-22. Inputting Pump Curves - a Worked Example: Input Data
Flow (m3/s) Head (m)
0 53.644
0.00378 53.035
0.00757 52.425
0.01136 51.816
0.01515 51.206
0.01894 50.596
0.02273 48.158
0.02651 44.196
0.03030 39.014

October 2020
Catalogues
Procedure
1. Click the Catalogues tab and open the Performance Data catalogue.
2. Open the Pumps catalogue and select the curve which best fits your requirements.
The Specific Speed for the curve we are creating is 26. The nearest curve in the
Simcenter Flomaster database to this is:
Suter Head Parameter - Radial Flow Pump curve, Ns = 25 √(m3/s)/ m 3/4
3. Right-click on the curve and choose the ¾ Copy option.
4. Click OK.
A confirmation dialog box is displayed. A copy of the curve is added to the catalogue.
5. To add the curve data for the 4th quadrant double-click on the copy to open the Curve
dialog:
6. From the Rated Conditions pane enter:
a. The new title for the curve in the Title field.
b. A required Rated Flow of 0.025 m3/s
c. A Reference Head/Torque value of 45 m.
7. Scroll down the Performance Data table to the first available blank row and enter the
data as shown Table 7-22 on page 347.
Note
The Rotation Direction column is automatically set to + for each new entry made.
8. Fit the curve by selecting Automatic Fit in the Degree Fit field.
Note
You can view the curve in suter form by opening the checking the Suter Values tab.
9. When you have finished, click Save.

Related Topics

October 2020
Catalogues
Creating Pump Torque Curves

There are two steps to creating new Pump Torque Curves, creation of the item itself and then
creation of the performance data.
Note
It may be more efficient, if a suitable item is available, to copy an existing Pump Torque
Curve and edit it.
Creating a Pump Torque Curve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

Adding Performance Data to a Pump Torque Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Creating a Pump Torque Curve

You can create new Pump Torque Curve performance data items.
Procedure
1. Right-click on the folder where you want to create the new Pump Torque Curve and
select New > Special Features > Pump Torque Curve.
The Curve dialog box opens.
Table 7-23. Creating a Pump Torque Curve - Entering and Amending the
Pump Torque Curve Data
To Do this
Add a title Click in the Title box and enter a title.
Add your own help 1. Click the button in the Help field to display the
details for the curve or Description dialog box.
surface 2. Enter the help details in the text box and then click OK.
The X Axis Unit is automatically set to Volumetric Flow Rate.
The X Axis Unit Symbol is set to l g.p.m. and can not be modified.
The Y Axis Unit is automatically set to Torque.
The Y Axis Unit Symbol is set to Nm. and can not be modified.
Set the axis scales Click in the relevant Axis Scale value cell to display a dropdown
list and use it to select either Linear or Logarithmic.

October 2020
Catalogues
Table 7-23. Creating a Pump Torque Curve - Entering and Amending the
Pump Torque Curve Data (cont.)
To Do this
Set the Pump Use the dropdown menu to select 26. Torque.
Characteristic
Set the Enter a value and set the units.
Reference Flowrate
Set the Reference/ Enter a value and set the units.
Head Torque
Results
The Pump Torque Curve is created. To use the curve or surface you must add some
performance data to it. See “Adding Performance Data to a Pump Torque Curve” on page 350.
Adding Performance Data to a Pump Torque Curve

You must add performance data to any newly created Pump Torque Curves before you use
them.
Prerequisites
• You must have created a new curve. See “Creating a Pump Torque Curve” on page 349
Procedure
1. Navigate to the Pump Torque Curve that you want to add performance data to and
double-click it to open the Curve dialog box.
2. Use the Pump Curve radio buttons to choose a data input type.
Choose from:
• Suter Parameter
• Normalized Values
• Actual Values
3. Either:
a. Enter values for the X and Y axes and the Direction in the Performance Data table.
Tip

October 2020
Catalogues
Whichever format you choose to enter the data (Suter Parameter, Normalized
Values, or Actual Values) the other two formats are automatically calculated and
available for review by selecting the appropriate radio button.
a. Click Digitize.
step 2 in “Creating a Pump Torque Curve” on page 349) these will be automatically
populated in the appropriate fields on the Curve Digitizer Axis Definition tab. If not,
you can use the dropdown list to set these.
Note
box.
e. By clicking on the image you imported specify:
ii. The origin
Note


October 2020
Catalogues

Delete key.
change.
4. You can scale the values by using the Factor Data... button (see Table Value Scaling
Function Dialog Box)
Note
data
data points

October 2020
Catalogues
Creating New Loss Curves

There are two steps to creating new loss curves, creation of the item itself and then creation of
the performance data.
Note
It may be more efficient, if a suitable item is available, to copy an existing curve or surface
and edit it.
Simcenter Flomaster converts defined loss data into a dimensionless format and so can take a
curve (for example Pressure Drop v Volumetric Flow Rate (ΔP v Q) or Pressure Drop v
Velocity (ΔP v V) and convert it into a curve of Loss Coefficient v Reynolds Number (K v Re)).
Conversions are performed by:
(7-25)
Where:
ε = Loss coefficient
Re = Reynolds number
Δp = Pressure loss
V = Volumetric flow rate
A = Flow area
dhyd = Hydraulic diameter
ρ = Fluid density
µ = Fluid dynamic viscosity
Creating a Loss Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

Adding Performance Data To A Loss Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

October 2020
Catalogues
Creating a Loss Curve

You can create new Loss Curve performance data items.
Procedure
1. Right-click on the folder where you want to create the new Loss Curve and select
New > Special Features > Loss Curve(s).
The Curve dialog box opens.
Table 7-24. Creating a Loss Curve - Entering and Amending the Loss Curve
Data
To Do this
Set the X and Y units Default setting:
• X = Volumetric Flow Rate
• Y = Pressure Difference
Curve Type option set to: DP v V, then:
• X = Velocity
• Y = Pressure Difference
Curve type option to: K v Re, then:
• X = Normalised Value
• Y = Loss Coefficient
Set the X and Yscales Default setting
• X = Linear
• Y = Linear
Curve Type option set to: DP v V, then:
• X = Linear
• Y = Linear
Curve type option to: K v Re, then:
• X = Logarithmic
• Y = Logarithmic

October 2020
Catalogues
Table 7-24. Creating a Loss Curve - Entering and Amending the Loss Curve
Data (cont.)
To Do this
Specify the Source If there is already a curve in the Simcenter Flomaster database that
Curve you want to use “as is” or convert to another format you can use
the S... button to open the Selection from Catalogue dialog and
select the curve.
Set the Hydraulic Enter a value and set the units.
Diameter and Area
Specify the Liquid Use the S... button to open the Selection from Catalogue dialog and
Option choose an appropriate material.
Set the Enter a value and set the units.
Reference Temperat
ure,
Reference Pressure,
Reference Density,
and
Reference Viscosity
Results
The Loss Curve is created. To use the curve or surface you must add some performance data to
it. See “Adding Performance Data To A Loss Curve” on page 355.
Adding Performance Data To A Loss Curve

You must add performance data to any newly created Loss Curves before you use them.
Prerequisites
• You must have created a new curve. See “Creating a Loss Curve” on page 354
Procedure
1. Navigate to the Loss Curve that you want to add performance data to and double-click it
to open the Curve dialog box.
2. Use the Loss Curve radio buttons to choose a data input type.
Choose from:
• DP v Q
• DP v V
• K v Re

October 2020
Catalogues
3. Either:
a. Enter values for the X and Y axes and the Direction in the Performance Data table.
Tip
Whichever format you choose to enter the data (DP v Q, DP v V, or K v Re) the
other two formats are automatically calculated and available for review by selecting
the appropriate radio button.
a. Click Digitize.
step 2 in “Creating a Loss Curve” on page 354) these will be automatically
populated in the appropriate fields on the Curve Digitizer Axis Definition tab. If not,
you can use the dropdown list to set these.
Note
box.
e. By clicking on the image you imported specify:
ii. The origin

October 2020
Catalogues
Note

Delete key.
change.
Note
data
data points

October 2020
Catalogues
Creating New Nusselt Surfaces

You can create your own Nusselt surfaces from dimensionalised heat exchanger test data.
Heat exchanger surface test data is usually supplied in one of the following formats:
• Q/ITD-Area v M1 & M2/Area

• Effec v Mass1-2 & Mass3-4
• Effec v Vol1-2 & Vol3-4.
When creating your own Nusselt surfaces Simcenter Flomaster allows you to specify a range of
settings for the hot side and air side flow rates and thermal effectiveness which are then used to
perform the required conversions.
Simcenter Flomaster uses the following correlations:
(7-26)
(7-27)
Where:
Re1-2 = Reynolds number fluid side
Re3-4 = Reynolds number air side
ṁ1 = Mass flow rate for hot fluid side
ṁ2 = Mass flow rate for air side
A1 = Hot side reference area
A2 = Air side reference area
d1, d2 = Hydraulic diameters
μ2 = Hot side fluid dynamic viscosity
μ1 = Air side fluid dynamic viscosity

October 2020
Catalogues
(7-28)
Where:
Nu = Nusselt number
U = Overall heat transfer coefficient
t = Thickness of the heat exchanger
Kair = Thermal conductivity of the air
(7-29)
Where:
q = Heat transfer
Cp = Specific heat
(7-30)
(7-31)
(7-32)

October 2020
Catalogues
(7-33)
Where:
qmax = Maximum heat transfer
ε = Effectiveness
(7-34)
Effectiveness changes with the number of tube rows, due to the turbulence of the airside flow.
For multiple tube rows. Effectiveness is modified to reflect the multiple tube rows effect in the
evaluation of the Nusselt number.
Creating a Nusselt Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Creating a Nusselt Surface

You can create new Nusselt Surface performance data items.
Procedure
1. Right-click on the folder where you want to create the new Nusselt Surface and select
New > Special Features > Nusselt Surface(s).
The Surface dialog box opens.
Table 7-25. Creating a Nusselt Surface - Entering and Amending the Nusselt
Surface Data
To Do this
Add a title Click in the Title box and enter a title.

October 2020
Catalogues
Table 7-25. Creating a Nusselt Surface - Entering and Amending the Nusselt
Surface Data (cont.)
To Do this
Set the Hot Side Use the dropdown menu to choose an appropriate value.
Flow, Air Side Flow Once set, the X, Y, and Z axes title fields are automatically
and the Thermal populated.
Performance Data.
Specify the Source If there is already a curve in the Simcenter Flomaster database that
Curve you want to use “as is” or convert to another format you can use
the S... button to open the Selection from Catalogue dialog and
select the curve.
Set the Thickness Enter a value and set the units.
Note: Thickness is the heat exchanger depth (in the direction of
airflow)
Set the Hot Side Click in the appropriate cells and use the S... button to open the
Fluid and Air Side Selection from Catalogue dialog and select the fluid/material.
Fluid.
Set the Hot Side Flow Enter a value and set the units.
Area and Air Side
Flow Area.
Set the hot side and Enter a value and set the units in the Hot Side Hyd Dia and Air
air side hydraulic Side Hyd Dia fields.
diameters.
Set the hot side and Enter a value and set the units in the Hot Side Inlet Pres and Air
air side inlet pressure. Side Inlet Pres fields.
Set the Number of Enter the number of tube rows in the heat exchanger.
Tube Rows Note: If you do not specify a value the default (1) is used.
3. Use the Nusselt Surface radio buttons to ensure that Test Data is checked.
4. Enter values for the Hot and Air Side Flows, Thermal Performance, and Hot and Air
Side Temperatures in the Performance Data table.
Tip
5. Click OK to save the performance data and close the dialog box.
A message is displayed to tell you that the surface has been added to the database. Click
OK.
6. Double-click on the new surface to re-open the Surface dialog box.

October 2020
Catalogues
The surface and its performance data has been saved and the test data converted to
Nu v Re12 & Re34 data.
7. You can now switch between Test Data and Nu v Re12 & Re34 data by using the
Nusselt Surface radio button.
Note
selecting them and using the Delete key. The surface in the right-hand pane is
9. Apply a mathematical fit surface to the data by choosing an option from the Degree Fit
• 99. Automatic - Simcenter Flomaster will pick the best fit polynomial curve for the
data
• 0. Linear Intrp. - Simcenter Flomaster will apply the best straight line fit through the
data points
• 1. Delauney Triangulation - A mathematical model for creating a mesh of triangle-
based polygons for a set of 3D points.
Note
This fit type may be unsuitable for data which describes a surface in high
resolution, in these instances selecting this option will display an error message
indicating that linear interpolation fit will be used instead.
• One of the polynomial curves.

The degree fit surface is displayed in the plot window when Nusselt Surface radio but is
set to Test Data.
11. Click OK to save and close the Surface dialog box.

October 2020
Catalogues
Flow Coefficient Curves

Simcenter Flomaster contains tools to help you create new flow coefficient curves.
In many industries the standard pressure/flow information is presented in the form of a Cv or Kv
Loss curve.
• The Cv value.
The number of US Gallons of water at 60oF per minute that, when flowing through a
valve, causes a pressure drop of 1 psi.
• The Kv value.
The amount of water (m3/h) at 20oC, with a pressure drop of 1bar.

Cv is proportional to Kv, but they are not interchangeable.
The curve v Opening may also be expressed in terms of Effective Area, Av in m2.
There are five options when creating a Flow Coefficient Curve:
• Linear
• Square Root
• Equal Percentage
• Hyperbolic
• Quick Opening
Table 7-26. Flow Coefficient Curve Types

Curve Equation
Linear

October 2020
Catalogues
Table 7-26. Flow Coefficient Curve Types (cont.)

Curve Equation
Square Root
Equal
Percentage
Hyperbolic

October 2020
Catalogues
Table 7-26. Flow Coefficient Curve Types (cont.)

Curve Equation
Quick Opening
Creating Flow Coefficient Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Creating Flow Coefficient Curves

You can create new Flow Coefficient Curve performance data items.
Prerequisites
• Before creating the curve, select the Units Set appropriate to the data that you want to
enter.
You can do this most easily by selecting an appropriate Session Units Set (from
Tools > Units > Select Session Unit Set...) or, more permanently, in the Properties of
the top-level Project. For more information on Unit Sets see “Maintaining Units” on
page 788.
Choose a Units Set according to the following Table:
If you have: With Units of Select Unit Set
Av m2 3. Metric
Cv Igpm of water at one psi 2. Imperial
Cv USgpm of water at one psi 4. Oil & Gas OR 5. American
Kv m3/h of water at one bar 1. Company OR 6. Oil Hydraulic
Procedure
1. Right-click on the folder that you want to create the new curve in and select
New > Special Features > Flow Coefficient Curve
The 2D Equation dialog box opens.

October 2020
Catalogues
or surface (optional) 2. Enter the help details in the text box and then click OK.
Create a Linear or 1. Click the Flow Coefficient Data button to display the Flow
Square Root curve. Coefficient Data dialog box.
2. Select Linear or Square Root from the Flow Characteristic
dropdown list.
3. Enter the required values for Valve Opening and Flow
Coefficient.
Note: These may be any point on the desired curve, except
Zero Opening; typically, they would be Maximum Opening
and the corresponding (maximum) Flow Coefficient.
4. Click OK to close the Flow Coefficient Data dialog box.
Create an Equal 1. Click the Flow Coefficient Data button to display the Flow
Percentage, Coefficient Data dialog box.
Hyperbolic, or Quick 2. Select the Equal Percentage, Hyperbolic, or Quick Opening
Opening curve. option from the Flow Characteristic dropdown list.
3. Enter the required values for Valve Opening and Flow
Coefficient.
Note: For a Hyperbolic Curve, this must be the fully open
position. For the other Types, they may be any point on the
desired curve, except zero Opening.
4. Enter a suitable value in the Rangeability (α) or Power field.
• Rangability is the maximum controllable flow divided by the
minimum controllable flow.
In practice this would be the Flow Coefficient of the fully-
open valve divided by that of the valve at minimum opening.
• Power is the reciprocal of the index power to which the
opening is raised.
5. Click OK to close the Flow Coefficient Data dialog box.
3. Click OK to close the 2D Equation dialog box.

October 2020
Catalogues
Catalogues - Scripts
Catalogues - Scripts
Scripts are programs which instruct Simcenter Flomaster or other applications to perform
specific functions. For example, initializing objects at the start of a simulation (initialization
scripts), or tidying things up when the simulation has finished (post-processing scripts).
They can also be used to create objects such as slider bars. The controller and gauge template
components, which make automation possible, make use of scripts.
You can write your scripts in C# , VB.NET, VB Script, or Java Scrip using the
Simcenter Flomaster script editor
You should keep your scripts as simple as possible. If very involved code is required, then it is
better to write an external COM object and then use a simple script to exploit the object's
functionality.
If this is not convenient, then you can use a more powerful development environment, such as
one of the following Microsoft Express Editions of:
• Visual Basic
• Visual C#
You can download these Express Editions free of charge. More details can be found at http://
www.microsoft.com/express/
Depending on the type of script, they are stored in one of the following catalogues:
• Simcenter Flomaster Supplied Generic - This is where Simcenter Flomaster supplied

scripts are stored. These scripts are only updated during upgrade to a newer version.
• User Defined - This is used to store scripts that you create. There are two sub-
catalogues:
o Database - This is where all 'project specific' scripts are stored. They are 'owned' by
the project for which they are created, in the same way as curves, surfaces, etc., and
have the same security. They are also handled in the same way as curves, surfaces by
the Pack/Unpack facility.
o Network - This is where all 'network specific' scripts are stored. Any script with
'hard coded' data which is network specific, should be stored in this area. The scripts
are only visible to the owning network and will be included with the rest of the
network files during Pack/Unpack operations.
• Other Scripts - Any other scripts you create should be stored in a suitably named
catalogue, under the main scripts catalogue.
You can import scripts into Simcenter Flomaster.

October 2020
Catalogues
Creating Scripts - General
• For networks that use scripts, you can use the Upgrade facility. When you do this, the
scripts are loaded into a catalogue, with a name that matches the name of the network
that they belong to. This catalogue can be found in the main Scripts catalogue.
• For other scripts, you can use the Pack/Unpack facility. When you do this, the script is
again unpacked into the 'User-defined' catalogue.
Creating Scripts - General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

You can create you own scripts.
Procedure
1. Open the Scripts catalogue.
2. Right-click on the catalogue where you want to store the new script and choose the New
option to display the Script Setup dialog box.
3. Select the Script Type and Script Language.
4. Enter the Script Name, and if required a description.
5. If the script you are creating also requires an 'Initialization Script' to be included in the
compilation then:
a. Click the [...] button to display the Selection form Catalogue dialog box.
b. Search for and select the required script.
6. Click OK to display the Script and Plug-In Editor dialog box.

October 2020
Catalogues
Figure 7-35. Creating Scripts - Script and Plug-In Editor
• The Edit Code pane shows the code stub details, and is where the code is entered.
• Any errors generated during compilation are displayed in the Errors pane.
• The bottom pane shows the Footer code, while the right-hand pane shows the
Document Outline view.
7. When you choose a script, Simcenter Flomaster automatically generates the 'Header
Code Stub'. This details the relevant interfaces, classes, etc that are required.
All you need to do, is to enter the required code at the relevant points in the code stub.
As you do this, you can use the editing controls to: indent or outdent lines, cut and paste
lines, find and replace words or terms, undo or redo changes, etc. The dialog box also
incorporates 'intellisense' to help you when you enter the code.
8. Once you are satisfied with the script, click the to compile the script. If any errors
are found during compilation, the messages are displayed in the Errors pane.

October 2020
Catalogues
Related Topics
Creating Scripts - Examples

October 2020
Catalogues

Examples on how to create the following scripts are given below.
Example 1: Creating a VB.Net Slider Bar Initialization Script . . . . . . . . . . . . . . . . . . . 371
Example 2: Creating a C# Slider Bar Initialization Script . . . . . . . . . . . . . . . . . . . . . . . 372
Example 3: Creating a VB.Net Controller Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Example 4: Creating a C# Controller Script. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Example 1: Creating a VB.Net Slider Bar Initialization

Script
An example of how to create a VB.Net Slider Bar Initialization Script.
Procedure
1. Locate the catalogue where your scripts are stored. Right-click on it and choose the New
Option to display the Script Options dialog box.
2. Enter the name for the script, and if required, a description.
3. Select the Network Initialization b. and VB.NET script type and language:
4. This example uses a slider bar; reference the Interop.FM2_INPUTSLib.dll. as follows:
a. Click the Set References button to display the Script Reference DLL dialog box.
b. Add the reference by clicking the Add Reference button to display the Select DLL
to be Referenced dialog box, locating the required .dll and then clicking OK.
5. To add a GAC Reference click the associated button to display the Select References
from GAC dialog box. Select the required reference and click OK.
6. Click the OK button to display the Script and Plug-In Editor dialog box.
Simcenter Flomaster creates the basic code stub.
7. Insert the code for the slider bar (outlined in red).

October 2020
Catalogues
Figure 7-36. Example 1: Creating a VB.Net Slider Bar Initialization Script
8. Click the button to compile the code.
Example 2: Creating a C# Slider Bar Initialization Script

An example of how to create a C# Slider Bar Initialization Script.
Procedure
1. Follow Steps 1 and 2 from Example 1: Creating a VB.Net Slider Bar Initialization
Script.
2. Select the C# radio button and click OK to display the Script Editor dialog box.
3. Enter a title for the script, add a description and set the references to the external objects.
Simcenter Flomaster creates the basic code stub, which is shown in blue below.

October 2020
Catalogues
4. Insert the code that (i) declares the slider bar object and (ii) creates the slider bar (shown
in red below).
Figure 7-37. Example 2: Creating a C# Slider Bar Initialization Script
Example 3: Creating a VB.Net Controller Script

An example of how to create a VB.Net Controller Script.
Procedure
Script.
2. Select the Controller, Gauge or CAM Correlation and VB.Net options.
3. Click OK to display the Script Editor dialog box.
4. Add a title and description.
5. Enter the code as shown below.
Dim Position As Double
If (Manager.IsFirstIteration=1) Then Position = pos.Value
Controller.SetVar(1, Position)
End If
Position = Controller.GetVar(1) Controller.OutputValue = Position

October 2020
Catalogues
Example 4: Creating a C# Controller Script

An example of how to create a C# Controller Script.
Procedure
Script.
2. Select the Controller or Gauge and C# options.
3. Click OK to display the Script Editor dialog box.
4. Add a title and description for the script.
5. Simcenter Flomaster creates is the basic header and code shown below.
double Position;
if (Manager.IsFirstIteration==1)
{
Position = pos.Value; Controller.SetVar(1, Position);
}
Position = Controller.GetVar(1); Controller.OutputValue = Position;

October 2020
Catalogues
Catalogues - Macros
Catalogues - Macros
Macros (or scripts) are 'one off' programs which you can use in Simcenter Flomaster to perform
a specific function. A typical example would be a macro that communicated to an external
program (e.g. Excel) which would find the sum of the pipe lengths in the currently active
network.
You can write macros in C# , VB.NET, VB Script, or Java Scrip using the Simcenter Flomaster
script editor.
You should keep your macros as simple as possible. If very involved code is required, then it is
better to write an external COM object and then use a simple script to exploit the object's
functionality.
As with writing scripts, if this environment is not suitable, you can use a more powerful
development environment, such as one of the following Microsoft Express Editions of:
• Visual Basic
• Visual C#
More details can be found on the Microsoft web site.
Macros are stored in the Macros catalogue, a sub-catalogue of the Scripts catalogue.
Macros are stored in one of the following catalogues:
• Simcenter Flomaster Supplied Generic - This is where Simcenter Flomaster supplied

macros are stored. These scripts are only updated during upgrade to a newer version.
• User Defined - This is used to store macros that you create.
You can import macros in to Simcenter Flomaster:
• For any network related macros, you can use the Upgrade facility. When you do this, the
macro(s) are loaded into the User-defined catalogue.
• For other macros, you can use the Pack/Unpack facility. When you do this, the macro is
again unpacked into the User-defined catalogue.
Creating and Executing Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Creating and Executing Macros

You can create your own macros.
Procedure
1. Open the Scripts catalogue and navigate to the Macros catalogue.

October 2020
Catalogues
Catalogues - Macros
2. Right-click on the catalogue where you want to store the new macro and choose the New
option to display the Script Setup dialog box.
3. Check the Macro radio button and select the required script language.
4. Click OK to display the Script and Plug-In Editor dialog box:
Figure 7-38. Creating Macros - Script and Plug-In Editor
Simcenter Flomaster automatically generates a basic code stub (as shown above).
5. Enter the required code at the relevant points in the code stub.
Use the editing controls to: indent or outdent lines, cut and paste lines, find and replace
words or terms and undo or redo changes. The dialog box also incorporates 'intellisense'
(to help you when you enter the code) and macro recording and playback features.
6. Once you are satisfied with the macro, click the button to compile it.
7. To execute a macro either:

a. If you have just created a macro click Run in the Script and Plug- In Editor dialog
box.
b. Right-click on an existing macro and choose the Execute option.
When you do this, then Simcenter Flomaster is suspended until the macro has
processed.

October 2020
Catalogues
Catalogues - Macros
c. Right-click on an existing macro and choose the Exec.Async option.

When you do this you can continue to use Simcenter Flomaster while the macro is
being processed.
Note
Depending on the type of macro you have created, then you will see further actions
take place. For example, you may see an Excel Spread Sheet open or further dialog
boxes displayed, such as the Select Attribute dialog box which enables you to select the
attribute you want to process.

October 2020
Catalogues
Catalogues - Sub-systems and Sub-circuits
Catalogues - Sub-systems and Sub-circuits

A Sub-system is a user-defined collection of components that you can add to a network in one
go.
Sub-circuits should form a continuous string of components. Membership of a sub-circuit is
determined by the connectivity of the components comprising the 'would be' sub-circuit. Only
hydraulically, mechanically and thermally attached components can be used to create a sub-
circuit.
By using sub-circuits you can:
1. Create a number of separate circuits

2. Drag them into the Network Drawing window
3. Connect them up to form a more complex circuit
Creating Sub-Circuits
A sub-circuit comprises a sub-set of the components belonging to a circuit.
Procedure
1. Right-click on a connection between two components and choose the Identify Sub-
Circuit option.
The components forming a particular circuit (e.g. A/C, Humid Air, etc) are identified by
red boxes and a dialog box is displayed in the top-left corner of the window. The dialog
box identifies the circuit type.
2. To give the circuit a name, click in the Circuit Name field and enter the details.
3. To save the sub-circuit, click the Save to Catalogue button.

October 2020
Catalogues
Catalogues - Symbols
Catalogues - Symbols
Simcenter Flomaster contains three symbol sets. You can choose which symbol sets are
displayed when using components and you can also create your own symbols which you can
attach to your custom components.
The Simcenter Flomaster symbol stets are:
• Colored - this is the default set which is loaded at start-up

• Grey Scale
• Outline
Note
The component connectivity is not a symbol feature. It is the underlying analytical model
that determines connectivity.
For information on creating and modifying your own symbol sets see “Maintaining Symbol
Sets” on page 795

Creating New Symbols

You can create your own symbols which you can attach to your custom components.
Note
You cannot add symbols to any of the existing Simcenter Flomaster symbol sets. To add
your own symbols, you first have to create a new symbol set. To see how you do this see
Maintaining Symbol Sets.

• Custom symbols must be in one of the following formats and should not be greater than
48 x 48 pixels in size:
o .bmp
o .ico
o .gif
o .jpg

October 2020
Catalogues
Procedure
1. Right-click on the catalogue where you want to store your new symbol and select New.
The Select Symbol dialog box is displayed:
Figure 7-39. Creating a New Symbol - The Select Symbol Dialog Box
2. Enter the name for the symbol in the Enter Symbol Name: field.
3. Click the Select New Image button to display the Open dialog box.
4. Navigate to the folder that contains your new symbol graphic and click on it. The
symbol is displayed in the space provided and its details are displayed.
Note
Symbol files can be in one of the following formats: .bmp, .ico, .gif or .jpg.
5. You can scale the image by selecting the Stretch to Fit option.
To remove the symbol and choose another click the Remove button.
6. Click OK.
The catalogue where the symbol is stored opens and the new symbol is displayed.
Related Topics
Attaching Symbols to Components

October 2020
Catalogues
Changing the Appearance of Symbols

You can create your own symbols which you can attach to your custom components
Note
This procedure is normally only required when you: (i) create a new component based on an
Analytical Model, (ii) customize it to suit your requirements and (iii) attach a symbol to it.
Procedure
1. Navigate to the component that you want to attach the symbol to.
2. Double-click on the required component to display the Component Customization
Form.
3. Click the Select Symbol button to display the Selection from Catalogue dialog box.
4. Search for and select the required symbol.
5. Click OK to close the Component Customization Form.
Related Topics

You can change the appearance of symbols in the Network Drawing window.
Procedure
1. With the Network Drawing window open, go to the Tools menu and select Symbol Sets.
The Maintain Symbol Sets dialog box is displayed.
2. Select the required symbol set. Choose from:
• Coloured
• Greyscale
• Outline
3. Click OK.
4. You can specify the default symbol set:
a. Select Symbol Sets from the Tools menu.

October 2020
Catalogues
The Maintain Symbol Sets dialog box is displayed:

Figure 7-40. The Maintain Symbol Dialog Box
a. Choose from:
o Coloured - this is the default set which is loaded at start-up
o Grey Scale
o Outline.
Note
You can specify the order in which the symbol sets are presented to users by
using the arrows in the Maintain Symbol Sets dialog box.
b. Click OK to save and close the dialog box.

Related Topics

October 2020
Chapter 8
Using M.O. Controllers
By connecting a gauge a to component’s output, you can measure many of the component’s
features.
For details of which features can be measured for a given component see the appropriate
component details in the Simcenter Flomaster Component Reference Manual.
When you connect a gauge template to a component you must set the following features for the
component:
• Algorithm Type - Set to 1: Output = Input

• Output Quantity - This is automatically set when you select the required feature.
• Output Initial Value - This is set to the required value
• Output Clipping Min/Max Limits - These should be set as required
If you want to display an output in a plot window you must set the Plot Window No to: 1: 1'st
Window.

October 2020
Using M.O. Controllers

October 2020
Chapter 9
Printing and Customizing Plots and Network
Diagrams
You can view or print plots and customize the appearance of many of the items on plots (such as
the background color, line types, and axes). You can also print network diagrams.
Print Previewing Plots and Network Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Changing the Line and Marker Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Changing The Axis Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Customizing the General Features for Surfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Customizing the Display Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Menu Customization Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Changing The Colors of Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Customizing the Color of Surfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Exporting Graph and Plot Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Printing Plots and Surface Graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Using the Zoom Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Print Previewing Plots and Network Diagrams

The Print Preview dialog box provides functions to help you print Simcenter Flomaster
networks and plots
Procedure
1. Right-click in the network drawing window or plot window and choose the Print
Preview.
2. Then:
Table 9-1. Print Preview Options for Plots and Network Diagrams
Print the diagram or plot directly Click the button
Set the page settings Click the button
Set the printer settings Click the button

October 2020
Printing and Customizing Plots and Network Diagrams
Changing the Line and Marker Properties
Table 9-1. Print Preview Options for Plots and Network Diagrams (cont.)
Fit to screen Click the button
Zoom in or out Click the button to display a dropdown list
and select the required zoom option.
View one page Click the button
View two pages Click the button
View three pages Click the button
View four pages Click the button
View six pages Click the button
View pages If your network diagram comprises a number of
pages, you can scroll through the pages by clicking
the spin control arrows shown below:

You can specify the appearance of plot lines and markers.
Procedure
1. Open the Chart Properties dialog box by either:
a. For a plot, right-click on the plot line and select Line Properties....
b. For a curve or equation, right-click on the curve or equation and select View.

October 2020
Figure 9-1. Changing the Line and Marker Properties - Chart Properties Dialog
Box
2. Then:
Table 9-2. Changing the Line and Marker Properties

Change the legend 1. Click the Font button to display the Font dialog box.
title font and color 2. Select the required font, style, size and color and then click
OK. The results are displayed in the Preview box.

October 2020
Changing The Axis Properties
Table 9-2. Changing the Line and Marker Properties (cont.)

Change the mark and 1. Check the Mark and Line radio button:
line properties 2. For the Line properties:
a. To set Line Type, click the dropdown list and select the
required line type.
b. To set the color, click the example color to display the Color
dialog box. Choose a color and click OK.
c. To set the line width using the Width field.
3. For the Marker properties:
a. To set the symbol type, click the dropdown list and choose a
symbol set.
b. To set the color, click the example color to display the Color
dialog box. Choose a color and click OK.
c. To set the symbol width enter the required value in the
Width field.

You can change the axis properties such as the colors of lines and grids and the labels and
markers on the axes for plots.
Procedure
1. Open the Chart Properties dialog box by double-clicking on the required plot axis.

October 2020
Figure 9-2. Chart Properties Dialog Box - Example
2. Follow the steps below:
Table 9-3. Changing the Axis Properties

To Do this
Change the axis label title 1. Select the required axis.
font and color 2. Click the Font button to display the Font dialog box.
3. Select the required font, style, size and color and then
click OK.
Change the tick marks 1. Use the Select Axis drop down to select the required
axis.
2. Use the Major Tick Marks options to specify if tick
marks are shown and at what increment.
Change the value range for To set the Actual data range, click the associated radio
plots. button.
By default, the dialog box To set a manual value, click the associated radio button and
opens with the Actual data enter the required min and max values.
range within whole
increments option set.

October 2020
Customizing the General Features for Surfaces
Table 9-3. Changing the Axis Properties (cont.)

To Do this
Change the zoom control 1. Click the associated check box
settings for plots. 2. Enter the required values in the From and To boxes.
Change the multiple axis 1. Select the required axis. The axis is highlighted:
offset (for overlay plots 2. Enter the required offset value.
only).
Change the grid color for 1. Click the color shown to display the Color dialog box
plots. 2. Select the required color and click OK
Change the color of the axis 1. Select the required axis to highlight the check box.
and line (to match the grid 2. Click the check box.
color) for plots.
For Plots, you can make the 1. Select the required axis.
grid lines visible or hide 2. Click the check box to hide or show the grid lines.
them.
Invert the grid axes. 1. Select the required axis, for example the 'X' axis.
2. Click the check box to invert the plot.
Change the grid axes settings 1. Select the required axis, for example the 'X' axis.
to use a logarithmic scale 2. Click the check box.
Customizing the General Features for

Surfaces
You can customize how surfaces are displayed by specifying items such as the font details for
titles and axes and switching on/off grid lines.
Table 9-4. Video Topics Relating to Viewing and Editing Surfaces

Task Video
Viewing and Editing Surfaces: Using the View
Toolbar
Viewing and Editing Surfaces: Customizing

Surfaces
Procedure
1. Right-click in the Graph window and choose the Customization option. The Customize
dialog box opens.

October 2020
Customizing the General Features for Surfaces
Figure 9-3. Customize Surface Dialog Box
2. From this dialog box you can:
Table 9-5. Customizing the General Features for Surfaces Sets

To Do this
Change the legend 1. Click the All Font or Main Title Font button to display the
title font and color Font dialog box.
2. Choose a font, font style, and size and then click OK.
Note: You can only perform these changes for your own
supplied surfaces.
Hide/Display the The grid lines are displayed by default.
grid lines 1. Use the grid Lines radio buttons to select the axes to display.
Unselected axes are not displayed.
Set the plotting Select one of the following options:
method • Wire Frame - displays a simple wire frame image
• Surface - displays the surface in a solid color
• Surface with Shading - displays the surface in a shaded color
• Surface with Contouring - displays the surface with colored
contour lines.

October 2020
Customizing the Display Points
Customizing the Display Points

You can customize the graph display points by hiding them or changing data point properties
such as color.
Procedure
1. Right-click on the surface and choose the Data Points Properties option to display the
Actual Data Properties dialog box.
Figure 9-4. The Actual Data Properties Dialog Box
2. To set the properties:
Table 9-6. Customizing the Display Points Properties

To Do this
Change the style and 1. Click the Style dropdown list and select the required symbol
size type.
2. To set the size, click in the box and enter the required value.
Change the color 1. Click the Symbol Colour box to display the Color dialog box.
2. Choose a color and then click OK.
Change the border 1. Click the Border Colour box to display the Color dialog box.
color 2. Choose a color and then click OK.
3. To hide the display points right-click on the surface and select Show/Hide Data Points.
Menu Customization Buttons

You can use the Surface Customization dialog box to make style changes to surfaces.
Table 9-7. Using the Menu Customization Buttons

View the graph in 2D Click the button.
format
To change back to an orthogonal view, click the button.

October 2020
Changing The Colors of Plots
Table 9-7. Using the Menu Customization Buttons (cont.)

Apply a pre- defined Click the Apply Predefined Projection dropdown list and
projection select one of the options.
Apply a pre- defined Click the Apply Predefined Projection dropdown list and
light scheme select one of the options.
Increase or decrease 1. To increase the height of the graph click the button.
the height of the
graph 2. To decrease the height click the button.
Increase or decrease 1. To increase the width of the graph click the button.
the width of the graph
2. To decrease the width click the button.
Increase or decrease 1. To increase the depth of the graph click the button.
the depth of the graph
2. To decrease the depth click the button.
Use the zoom control You can use the zoom control to change the magnification within
the plot window.
Changing The Colors of Plots

You can change the colors for curve, equation, and results plots
Procedure
1. To change the chart background color:
a. Right-click on the plot window and choose the Chart Background Color... option.
The Color dialog box is displayed.
b. Choose a color and click OK.
2. To change the desk background (the color that surrounds the curve/plot) color:
a. Right-click on the plot window and choose the Desk Background Color... option.
The Color dialog box is displayed.
b. Choose a color and click OK.
Customizing the Color of Surfaces

You can use the Color Form on the Customization dialog box for surfaces to set the colors for
the graph background, foreground, etc.

October 2020
Exporting Graph and Plot Images
There is a video describing how to change the color of element for surfaces: Viewing and
Editing Surfaces: Customizing Surfaces
You can change:
• Desk Foreground - the color that is used when placing text onto the Desk Background.
This includes the main title, sub title and labels.
• Desk Background - the background color of the graphs' title box.
• Graph Foreground - the color used for the bounding rectangle of the grid, the grid-
lines, subset labels, grid numbers, and axis labels.
• Graph Background - the color used as the background color of the plots' grid.
• X and Y Axes Planes - the background color of the X and Y axes.
• Z axis plane - the background color of the Z axis.
• Wireframe - the color that is applied to the surfaces' frame, when the Wireframe mode
is selected on the General tab, on the customization form.
• Surface Color - the color that is applied the body of the surface, when either the
Surface or Surface with Shading modes are selected on the General tab, on the
customization form.
Procedure
1. Double-click in the graph window to display the Customize dialog box.
2. Open the Color tab.
a. Click the button next to the attribute you want to change. The Color dialog box
is displayed.
b. Select the required color and click OK.
The new color is displayed next to the selected attribute
3. Click OK to apply the changes to the graph.

You can export plots and graphs as BMP, EMF, Exif, GIF, ICO, JPG, PNG, TIFF, WMF, and
SVG file formats.
Procedure
1. Click the button to display the Chart Image Export dialog box.

October 2020
Figure 9-5. Exporting Graph and Plot Images - The Image Export Dialog Box
2. To export an image:
Table 9-8. Customizing the Data Point Properties

To Do this
Set the image size You can use the set control dimensions, or you can set the Width
and Height dimensions yourself:
1. Un-check the Use control dimensions option.
2. Set the required Width and Height dimensions.
Options
Set the bits per pixel Click the dropdown list and choose the required value.
Select the image 1. Click the dropdown list and select the required format.
format When you select the JPEG image format, the Quality (JPEG)
control is active.
2. Set the level of compression.
Render the image 1. Select the required image format.
grayscale 2. Click the dropdown list and select the required format
Final Actions
Copy the image to the Click the Copy to Clipboard button.
clipboard
Save the image to a 1. Click the Save to File button. The Save dialog box is displayed.
file 2. Navigate to the required folder and then click OK

October 2020
Printing Plots and Surface Graphs
Printing Plots and Surface Graphs

You can print plots or surface graphs using the Print or Quick Print button.
You can print the following items:
• Curve, Equation and Results Plots

• Surface Graphs.
Procedure
1. To send the graph or plot directly to the printer click the Quick Print button.
2. To print preview the graph or plot click the Print button. The Print Preview dialog box
is displayed.
Using the Zoom Button

You can magnify a portion of an plot by using the Zoom button. You can also use the mouse to
select new extents on the plot
Procedure
2. Holding the left button down, move the mouse up to zoom out from the image and down
to zoom in on the image.
3. To set new plot window extents:
a. Hold the left mouse button down and drag the cursor to select the new extents.
b. Release the mouse button.
The view changes to show an enlarged view of the area selected. As you zoom in on
an object, the axis scales change accordingly.
4. To reset the zoom function, Click on the plot and choose the Unzoom option.

October 2020
Chapter 10
Reports
You can produce several kinds of reports to audit and verify the performance of your system.
Errors and Warnings - Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Viewing Errors, Warnings, and Convergence Failures . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Generating Input Audit Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Generating Component Results Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Generating Network Data Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Generating Simulation Results Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Input Data Browser and Plug-in Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Generating an Input Data Browser Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Exporting an Input Data Browser or Plug-in Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Print Preview an Input Data Browser or Plug-in Report . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Saving an Input Data Browser or Plug-in Report as a Template . . . . . . . . . . . . . . . . . . . . 410
Executing, Deleting or Renaming Input Data Browser and Plug-in Report Templates . . . 411
Generating a Result Based Plug-in Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Accessing an Input Data Browser Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Errors and Warnings - Overview

During simulations it is common for Simcenter Flomaster to produce errors and warnings.
Errors
Errors are messages generated when the simulation fails to start or aborts part way through the
simulation. They usually occur because of incorrect data entry such as component (e.g. valve
position not set) or simulation data (e.g. tolerances too tight).
When you start a simulation, Simcenter Flomaster performs checks on the network and the
component data, any failure of these checks halts the simulation and an error message is
generated.
Warnings
Warnings do not cause a simulation to stop. They indicate things such as assumptions that
Simcenter Flomaster made during the simulation or to flag up when data is outside the expected
ranges. Insufficient data points, points in the simulation where conditions strayed outside the

October 2020
Reports
Viewing Errors, Warnings, and Convergence Failures
bounds of performance curves, and points where the solution failed to converge would all cause
warnings.
Viewing Errors, Warnings, and Convergence

Failures
Simcenter Flomaster will list any errors, warnings, or convergence failures during simulations.
You can also review these for any previously run simulations.
Video
The video gives an overview of Errors, Warnings, and Input Data Audit Reports.
Procedure
1. During simulation:
a. With the Simulation Data tab open, if any warnings or errors are reported the
warnings ( ) or errors ( ) buttons will be displayed (in the
bottom area of the Simulation Data tab).
b. You can view the details of warnings and errors by clicking the appropriate button.
Tip
You can also access the warnings and errors reports by clicking or from the
Data Tab.
Note
In the event of a Simulation failure the error report is automatically displayed.
2. Post simulation:
a. Open the Result Sets/Results tab and double-click on the Results Set that you want
to view.
The Results Set opens.

October 2020
Reports
Generating Input Audit Reports
b. With the Simulation Data tab open, if any warnings or errors were reported during
simulation the warnings ( ) or errors ( ) buttons will be
displayed (in the bottom area of the Simulation Data tab).
c. You can view the details of warnings and errors by clicking the appropriate button.
Tip
You can also access the warnings and errors reports by clicking or from the
Data Tab.
3. You can view convergence warnings from the warnings or errors report by selecting the
Append Convergence Warnings option.
Tip
You can dock, undock, and reposition the warnings and errors reports.
Related Topics
Generating Input Audit Reports

You can use Input Audit Reports to show the differences in input parameters for components
and nodes across multiple simulations (Result Sets).
Prerequisites
• A network open in the network window.
• At least two Result Sets.
Video
This video gives an overview of the Input Audit Report functions
Procedure
1. Open the Result Sets/Audit tab and choose at least two result sets.

October 2020
Reports
Generating Component Results Reports
Tip
You can use the CTRL key to select multiple results sets.
2. Click the button to display the Input Data Audit Report dialog box.
Only components with differences in at least one input parameter are listed in the report.
If there are no differences between the selected Result Sets a message is displayed
indicating this.
3. You can use the column filters, , to limit which components are listed
in the report.
4. You can save a copy of the report to Microsoft Excel:
The Save to Excel dialog box opens.
b. Navigate to a folder to save the Excel file and Click OK
Generating Component Results Reports

You can create reports which summarise selected results for selected components.
Prerequisites
• A Result Set.
Procedure
1. Open the Result Sets/Audit tab and choose a Result Set.
2. Create a collection of the components that you want to see the results for (see
“Collecting and Filtering Component and Node Results” on page 418)
The Component Results Report opens.

4. You can:
• Resize columns
• Arrange columns by dragging and dropping them.
• Remove columns by dragging the column header off the report.
• Group report items by dragging column headings into the “group by area” zone.

October 2020
Reports
Generating Network Data Reports
5. You can save the report layout for reuse:

The Save Results Layout dialog box opens.

b. Enter a name for the Report Layout and click OK.
c. The Report Layout is saved in the Network's Documents folder.
If you have previously saved Report Layouts you can select these from the dropdown
menu.
6. You can save a copy of the report to Microsoft Excel:

The Save to Excel dialog box opens.

b. Navigate to a folder to save the Excel file and Click OK

Network Data Reports detail all the settings made on the General Data and Simulation Control
form.
There are four types of network data reports:
• Plug-in Report

October 2020
Reports
• Crystal Reports - this option can be used to produce a report that shows:
o The simulation type being used (e.g. Steady State).
o Details of any simulation options that have been selected (e.g. Component
Interaction).
o All the relevant sub-form (e.g. Ambient Data) settings.
o Details of the components used in the network and their settings.
o Details of the nodes and their settings and associated circuit type(s).
• EDIF File - selecting this option produces an EDIF file that can be attached to a batch
file and then processed, via the command line.
• MpCCI Link File - this option produces an ASCII file containing the relevant data.
Prerequisites
• An network open in the network window.
Components and nodes in the collection list.
Procedure
1. With the Network Drawing window open click the button.
Figure 10-1. The Network Data Report Options

October 2020
Reports
Generating Simulation Results Reports
2. Then:
Table 10-1. Generating Network Data Reports

To Do this
Set the report type Select the required radio button.
Choose a plug-in report Select the required radio button.
Set the content for a Note: By default all content type options are selected. To
crystal report choose a single option or combination of options un-check
the ones not required. These options are not available if you
select the EDIF option.
1. To show only the Description, General Data or Set Data,
then un-check the remaining options.
2. If you want to show data for the selected simulation type
choose the Simulation Filter check box.
3. To include component interaction data select the associated
check box.
4. To include components and/or nodes select the required
option.
Set the content for an Depending on the type of EDIF file you want to produce select
EDIF file All or Current Selection option(s).
Show the compiled 1. Click OK. The report window opens showing the report. At
crystal report the top of the window is a row of buttons. To see what they
do, move the mouse over the required one to display a tool-
tip.
Show the EDIF file Click OK to display the EDIF file dialog box. The dialog box
enables you to edit the EDIF data.
Related Topics

Simulation results reports detail the results for all the components and nodes in the network.
They typically show:
• The name of the network

• Details of any observations
• Details of the components and their associated results
• Details of the nodes and their associated results.

October 2020
Reports
Prerequisites
• At least one set of simulation results
Procedure
1. Open the Result Sets/Audit tab and choose a results set.
The Run Result Report dialog box is displayed.

3. Select Run Built-In Report and click OK
The Analysis Result Report Generation Options dialog box is displayed:
Figure 10-2. The Analysis Result Report Generation Options
4. Then:
Table 10-2. Generating Simulation Results Reports

To Do this
Select components only 1. Select the All or Current Collection option.
or nodes only 2. For Nodes only, check the None option for components.
3. For Components only, check the None option for Nodes.
Select the Report Based Click the required option button.
On option

October 2020
Reports
Table 10-2. Generating Simulation Results Reports (cont.)

To Do this
Set the Result File Read 1. Click the Read every time step cell and enter the required
Interval (Transient only) value.
2. Enter the Start and End values.
Choose a results type. Select the required check box in the Value column.
For example, to select nodal pressure values, click the check
box next to Node: Pressure.
Select values which are Click the corresponding if Gt. Than or if Lt. Than cell and
less than or greater than a enter the required value.
specified value for a For example, to elect nodal pressure values less than say, 0.5,
results type click the if Lt. Than cell and enter the value.
Show the compiled report 1. Click OK.
The report window opens showing the report. At the top of
the window is a row of buttons. To see what they do, move
the mouse over the required one to display a tool-tip.
Related Topics

October 2020
Reports
Input Data Browser and Plug-in Reports
Input Data Browser and Plug-in Reports

An Input Data Browser Report enables you to produce a highly detailed data report, for all kinds
of networks.
With input data browser reports:
• The grid is displayed in a 'tabbed' window. This means that you can easily switch from
one window to the next.
• Columns in the grid can be sorted, resized and grouped together. For example, the
'Integer' and 'Real' value columns could be grouped together.
• Filters are supplied that enable you to sort the data by component type, feature, result,
etc.
• The Pipe Profile Report is split into two sections. The top section shows a summary of
the pipe data, while the bottom section shows the pipe profile results.
• For Input Data Browser Reports, provision is made for handling variable parameters.
• Data can be:
o Exported to an Excel spreadsheet.
o Saved as a template, for future use.
o Print-previewed.
To generate the reports, a plug-in is required in the form of Dynamic Linked Library (dll).
Simcenter Flomaster contains the following plug-ins:
• FlowmasterReport.InputDataBrowser.dll - enables a data-based report to be produced

• FlowmasterReport.PipeProfileResults.dll - enables a pipe profile report to be produced
Generating an Input Data Browser Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Exporting an Input Data Browser or Plug-in Report . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Print Preview an Input Data Browser or Plug-in Report . . . . . . . . . . . . . . . . . . . . . . . . 408
Saving an Input Data Browser or Plug-in Report as a Template . . . . . . . . . . . . . . . . . . 410
Executing, Deleting or Renaming Input Data Browser and Plug-in Report Templates 411
Generating a Result Based Plug-in Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Accessing an Input Data Browser Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Generating an Input Data Browser Report

You can generate a report to display simulation input data.

October 2020
Reports
Exporting an Input Data Browser or Plug-in Report
Procedure
1. With the Network Drawing window open, click the button.
The Network Data Reports dialog box is displayed.

2. Select the Report Type and Network Data contents then click OK. The report opens.
The report data is displayed as series of columns. The data in each column can be
filtered or grouped.
3. To remove a column that you do not want to view:
a. Right-click in a column header to display the menu shown below:
Figure 10-3. The Remove Column Menu
b. Un-check the column you want to remove.
Note
Clicking on an un-checked column name will add that column back into the
report.
4. You can group the report data by dragging the required column header into the marked
area.
Use the required filter to again see only the data you are interested in.
Exporting an Input Data Browser or Plug-in Report

You can export the contents of an input data browser or plug-in report as an .XML Spreadsheet,
or a Comma Separated File.
Procedure
1. Click the Export Data.
The Save As dialog box opens.
2. Navigate to the required location.

October 2020
Reports
Print Preview an Input Data Browser or Plug-in Report
3. Enter the file name and select the required file type.
4. Click OK.
Print Preview an Input Data Browser or Plug-in

Report
You can preview data before printing it.

October 2020
Reports
Print Preview an Input Data Browser or Plug-in Report
Figure 10-4. Pipe Profile Data Example

October 2020
Reports
Saving an Input Data Browser or Plug-in Report as a Template
From this dialog box, you can perform the following actions:
Table 10-3. Viewing the Report Data
To Do this
Choose a printer To choose a printer other than default one, click the dropdown
list and select the required one.
Select the paper size Click the dropdown list and select the required size.
Select the page Select the required radio button.
orientation
Print the data or results Click the button.
directly
Increase or decrease the Click the or button.
text size
Set the size to 100% Click the button.
Set the page width Click the button.
View the whole page Click the button.
View two pages Click the button.
When you have finished, click the Print button.
Saving an Input Data Browser or Plug-in Report as

a Template
You can save input data browser or plug-in reports as a report template and attach it to a
network for later use.
Procedure
1. Click the Save as Template button to display the Workflow Name and Description
dialog box.
2. Enter a name for the Report Template.
3. Select either:
a. Generic - the template is attached to all networks.
b. Network/Result Set(s) Specific - the template is attached to the currently displayed
network only.
4. If required, enter a description of the report in the Description box.
5. Click OK to save and close.

October 2020
Reports
Executing, Deleting or Renaming Input Data Browser and Plug-in Report Templates
Executing, Deleting or Renaming Input Data

Browser and Plug-in Report Templates
You can execute, delete, or rename report templates.
Procedure
1. Open the Data tab.
2. Click the button. The Reporting Templates dialog box opens.
Figure 10-5. Executing, Deleting or Renaming Input Data Browser and Plug-in
Report Templates - The Reporting Templates Dialog Box
From this dialog box you can:
Table 10-4. Viewing the Report Data

To Do this
Delete a report Select the required report and then click the Delete button.
Execute a report Select the required report and then click the Execute button.

October 2020
Reports
Generating a Result Based Plug-in Report
Table 10-4. Viewing the Report Data (cont.)

To Do this
Rename a report 1. Select the required report and then click the Rename
button. The Name Entry dialog box opens.
2. Enter the new name and then click OK.
Update a description for 1. Select the required report to display its description.
a report 2. Enter the new description and then click the Update
button.

You can use Result Based Plug-in Reports to report the results for pipe profiles.
The Result Based Plug-in Report is divided in to two sections.
• The top section displays a summary of the pipe data

• The bottom section displays the pipe profile results
Procedure
1. Open the results table from the Network Drawing window by selecting the Results radio
button.
2. Click the button. The Run Result Report dialog box is displayed.
3. Select the Run Plug-in Report option.

4. Select the Pipe line profile results plug-in and click OK.
Note
The Cavitation column indicates whether or not cavitation is present for a particular
pipe.
5. Print out the report and modify it by filtering and grouping data and removing columns.
You can also perform any of the following options:
• Print Preview the Report — Click the Print Preview button to display the Print
Preview dialog box.

October 2020
Reports
• Show on Chart — Click this button to display a plot of the results:

Figure 10-6. Generating a Result Based Plug-in Report - Displaying Plot Results
The blue line in the foreground is the Pipe Profile curve, from which the mile posts
are read and used to generate the profile data.
Cavitation is displayed as a highlighted region on the plot:
Figure 10-7. Generating a Result Based Plug-in Report - The Cavitation Plot
• Update Results — Displays changes in the report due to data changes.

October 2020
Reports
For example:
o By entering a new value for Vapor pressure, and then clicking the Update
Results button, you can see if cavitation is likely to occur.
o Entering a new time value for transient simulations.
• Look at Location Warnings — Location warnings are generated when an overlap,
or separation problem occurs between two pipes. To look at location warnings:
Figure 10-8. Generating a Result Based Plug-in Report - Pipe End Location
Warnings
In the example shown above, an overlap has occurred between End 2 of Pipe 632
and End 1 of Pipe 633. When an overlap occurs, it usually means that the pipe length
is wrong and/or, the mile post needs to be changed.

October 2020
Reports
Accessing an Input Data Browser Report
• Look at Level Warnings — Level warnings are generated when there is difference
between the entered node level settings and the pipe profile curve. To look at level
warnings, click the button to display the dialog box shown below:
Figure 10-9. Generating a Result Based Plug-in Report - Node Level Warnings
In this example there is level difference between End 2 of Pipe 632 and End 1 of
Pipe 633. To solve this, adjust the level of the relevant node (node 630).
• Exporting Data or Results — Clicking either button enables you to export the data
or the results as an .XML Spreadsheet, or a Comma Separated File. To do this:
i. Click the required button to display the Save As dialog box.
ii. Navigate to the required location; enter the file name and then click OK.

You can access a report using the Simcenter Flomaster interface.

October 2020
Reports
Procedure
1. To access the report, open the required network and click the + sign next to Report
Templates. The view changes to the one shown below:
Figure 10-10. Accessing an Input Data Browser Report - Example 1
2. To execute the report, right-click on the report and select Execute....

October 2020
Chapter 11
Results
Simcenter Flomaster has a range of ways for reviewing the results of simulations.
The Network Views Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Collecting and Filtering Component and Node Results . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Drawing Component and Node Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Viewing Component Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Viewing Node Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Validating Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Accessing Results from the Project View Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Attaching Items to Results Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Deleting Result Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Protecting Result Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Plotting Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Frequency Domain Processing and Fourier Transform Plots . . . . . . . . . . . . . . . . . . . . . . . 440
Fourier Transformation Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Dashboards - Creating a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Dashboards - Creating Plots of Component Values Versus Time . . . . . . . . . . . . . . . . . . . 445
Dashboards - Creating Plots of One Component Value Versus Another . . . . . . . . . . . . . . 446
Dashboards - Working with Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Air Conditioning Results - Plotting a P-h Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Plot a Selected Feature Against Another Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Viewing Results Dynamically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Network Results Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Creating and Using Network Result Sensors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
The Network Views Dialog Box

The Network View dialog box is used to view component and node results and details about
simulations that you have run.

October 2020
Results
Collecting and Filtering Component and Node Results
The Network view dialog box is usually on the right-hand side of the Network window but you
can dock and undock it and position it anywhere in the Simcenter Flomaster interface.
You can switch the Network View off and on using the Views > Network View option.
The Network Views dialog boxhas a top and bottom pane. The top-pane displays:
• The order in which the simulation was performed

• Whether or not the results have been signed off (see Protecting Result Sets).
• Whether or not the results are hybrid results (see “Hybrid Results” on page 814).
• The simulation type (e.g. Incompressible Steady State, etc.)
• A brief description of the simulation
• The date and time the simulation was performed
• Whether or not the simulation was successful.
When you choose a result set, its properties are shown in the bottom pane. These include:
• Simulation Type - shows details of the simulation type (e.g. Steady State, Transient,
etc.)
• Description - shows a brief description of the simulation.
• Creator - shows the name of the person 'owning' the simulation.
• Date and Time - shows the date and time that the simulation was run.
• OK? - shows the status of the simulation: Yes, No (If the simulation fails to achieve a
converged solution), or Crash.
• Observations - enables you to enter details about the simulation.
To do this, click in the adjacent cell to display a button. Click the button to display the
Result Observation dialog box. Enter the details and then click OK.
Collecting and Filtering Component and Node

Results
Collecting components and nodes is useful when managing and viewing the results of
simulations.

October 2020
Results
Video
A video, Collecting Components and Nodes, is available:
Procedure
1. Click the button to open the Component Results Filter dialog box
Figure 11-1. Collecting and Filtering Component and Node Results - The
Component Results Filter
The Component Catalogues pane shows the catalogues for the components and nodes
used in the network. The right-hand pane shows a list of variables for selected
components.
2. To plot on a particular component type and variable type select the component from the
component catalogues list and then the particular variable.

October 2020
Results
3. From this dialog box:
Table 11-1. Collecting and Filtering Component and Node Results

To Do this
Collect ALL components Click the required button.
or nodes for displayed
variables
Show variables for a 1. Open the catalogue in the Component Catalogues pane and
selected component select the component.
2. To see the contents of ALL the catalogues select the All
check box.
Enable/disable variable Note: Enable Variable Checking is selected by default.
value checking To disable it, un-check the Enable Check on Variable option.
Filter options are also disabled.
Collect test values that 1. Select the required variable from the Variable Value Check
are less than or greater pane.
than a specified value, for 2. Click the Less than or Greater than option button.
a selected variable 3. Enter the value in the Test Value cell.
4. Click the Collect button to collect components that fit the
selection criteria.
Collect test values that 1. Select the required variable from the Variable Value Check
are between specified box.
values, for a selected 2. Click the Between option button.
variable 3. Enter the minimum value in the left Test Value cell and the
maximum value in the right Test Value cell.
4. Click the Collect button to collect components that fit the
selection criteria.
Collect Minimum or 1. Click the required option button.
Maximum simulation
values (Transient
simulations only)
Add to or replace the 1. Click the required option button.
current collection 2. Click OK. Depending on the selection made, the following
actions occur: (i) the components are loaded into the
Collection List, and (ii) their associated results are
Related Topics
Drawing Component and Node Results

October 2020
Results

You can display component and node results in the Network Drawing window.
Video
A video, Displaying and Plotting Results, is available.
Procedure
1. Click the required component to display its properties.
2. Select the required attribute (e.g. Arm 1: Mass Flow Rate) from the properties list.
3. Click the button. The Draw Attribute dialog box is displayed:
Figure 11-2. The Draw Attribute Dialog Box
Table 11-2. The Draw Attribute Options

Option Action
Label Draws the selected attribute (e.g. Arm 1 Mass Flow Rate) for
ALL components in the network.
Table Draws a selected attribute for a selected component, in the form
of a table.
Colour Code Selecting this option and clicking OK, activates the Color
Range/Band dialog box.
4. To display the selected attribute for each component, click OK.

October 2020
Results
5. To display the results as a table, select the option and click OK. The results are
displayed as shown below:
Figure 11-3. Drawing Component Results - Example 1
To append another result to the table for the same component:
a. Select the required result, and then click the button.
b. Reselect the Table option and select the Append Results check box.
c. Click OK
6. To display the results in color, select the option and click OK.
The Colour Range/Band dialog box is displayed.
If you have already set up a color scheme, then select it from the available schemes and
click OK. Depending on the chosen scheme, then the results are displayed in the
corresponding colors.
If you have not set up a color scheme you can create one by:
a. From the The Colour / Range Band Selection Dialog Box click the New Scheme
button.
b. Select the Interpolated or Range Bands option.
c. Specify a value in the Add Range field. This is the value (in pressure, flow or
temperature) between each item in the range.
d. Ensure that the Auto Colour option is checked to allow Simcenter Flomaster to
assign colors to your new ranges. If you leave this unchecked you can specify the
color for the range that you create.
e. Enter a value for the first range limit by clicking the adjacent cell and enter the
value.
Note
Negative values can be added.
f. Enter a name for scheme and then click OK.

Related Topics

October 2020
Results
Viewing Component Results

You can view component results directly from the Network Views window.
Prerequisites
• A network with some simulation results.
Procedure
1. Open the Results Sets/Audit tab and select the results set that you want to view.
2. Click on the Data tab to see all the components in the list.
3. Select the Results option.
4. Choose a component from the Collection List to display the results in the bottom pane.
Then:
Table 11-3. Viewing Steady State Component Results

To Do this
Draw component results This option enables you to display results for selected features
on the network diagram in the Network Drawing window. See Drawing Component and
Node Results for more information on drawing results.
Draw color coded This option enables you to display color results for selected
component results on features in the Network window. To do this:
network diagram 1. Select the required feature from the results list.
2. Click the Draw button to display the Draw Attribute dialog
box.
3. Check the Colour Code Results option and click OK.
The Dynamic Colouration dialog box is displayed.
4. Select the type of colouration:
a. Interpolated
b. Range Bands.
Note: If you have already set Dynamic Colouration at the
start of the simulation, and saved the color scheme, then
you can use this scheme when animating the results. To do this,
select it from the list in the left pane. A notification dialog box
is displayed. Click No to display the selected scheme.
If you have not set-up any Dynamic Colouration then:
Depending on
(i) the values set and
(ii) the colors chosen, then the colors of the components in
the Network Drawing window will change.

October 2020
Results
Viewing Node Results
Table 11-3. Viewing Steady State Component Results (cont.)

To Do this
Plot a gradient plot This option enables you to display a gradient plot for
components in the feature collection. To do this:
1. Select the required feature from the results list.
2. Click the button. A plot window opens showing the
results.
Display a list of feature This option enables you to list selected feature values for a
values v component selected component. To this:
number 1. Select the required feature from the results list.
The Results List dialog box opens. It comprises a two-
column spread sheet showing plot values vs component.
3. To copy the data to the clipboard for use by another
application (e.g. Word, Excel):
a. Click in the top of left row and drag the mouse down.
As you do this, the data in both adjacent rows is
highlighted
b. Click the Copy button and then the Close button to close
the dialog box.
Generate a Simulation Simulation Results Reports detail the results for all the
Results Report components and nodes in the network.
See “Generating Simulation Results Reports” on page 403
Related Topics

You can view node results directly from the Network Views window.
Prerequisites
• A network with some simulation results.

October 2020
Results
Procedure
1. Open the Results Sets/Audit tab and select the results set that you want to view.
2. Click on the Data tab to see all the components in the list.
3. Select the Results option.
4. Choose a component from the Collection List to display the results in the bottom pane.
Then:
Table 11-4. Viewing Node Results

To Do this
Draw node results on the This option allows you to display results for selected features in
network diagram the Network Drawing window.
1. Select the required feature.
2. To draw Max/Min values, click the required radio button.
3. Click the button. The Draw Attribute dialog box is
displayed.
4. Click OK to display the results for each component.
Plot a gradient plot 1. Select the required feature.
showing Max/Min results 2. To draw Max/Min values, click the required radio button.
for all nodes in the 3. Click the button. A plot window opens showing the
network
results.
List all node results for a 1. Select the required feature.
selected feature 2. Click in the adjacent cell to expose three buttons and click
the button. The Result List dialog, which comprises a
two-column spread sheet showing result values vs node
numbers, is displayed.
application:
a. Select the content to be copied
the dialog box.
Plot a selected feature See Plot a Selected Feature Against Another Feature
against another feature
Plot Time Related Events for Selected Nodes (Transient Simulations Only)
Plot a selected feature for 1. Select the required node.
a selected node 2. Select the feature you want to plot.
3. Click in the adjacent cell to expose three buttons. Click the
button. A plot window opens showing the results.

October 2020
Results
Validating Results
Table 11-4. Viewing Node Results (cont.)

To Do this
Plot a list of results for a 1. Select the required node.
selected node 2. Select the feature you want to plot.
3. Click in the adjacent cell to display three buttons. Click the
button. The Results List dialog, comprises a two-column
spread sheet showing plot values vs node ID, is displayed.
application:
a. Select the content to be copied
the dialog box.
Plot a selected feature 1. Select the required node.
against another feature 2. Select the feature you want to set as the 'X' axis.
3. Click in the adjacent cell to expose three buttons. Click the
button.
4. Select the 'Y' axis feature.
5. Click in the adjacent cell and click the button. The Plot
window opens to display the combined results.
Generate a Simulation Simulation Results Reports detail the results for all the
Results Report components and nodes in the network.
See “Generating Simulation Results Reports” on page 403
Related Topics
Validating Results
You can use the Network Results Validation report to check component and node results against
pre-determined rules. For results which fail the rules you created, you can collect the nodes and
components for further investigation.

October 2020
Results
Validating Results
This video demonstates how to use the Network Results Validation report:

• The Network Results Validation report displays steady state results. For transient
simulations the initial results/conditions are displayed.
Prerequisites
• A network open in the Network Drawing window
• A set of results
Procedure
1. Open the Results Sets/Audit tab and select the Results Set that you want to analyse.
Note
If you do not choose a specific Result Set the latest is used. When opening a network
that already has Network Result Validation rules the report will display data from
the latest Result Set, even if those rules were created using earlier results.
2. Click the Network Result Validation button, .
The Network Result Validation pane opens.
Note
The Network Result Validation pane can be docked/undocked and positioned
anywhere in the Simcenter Flomaster window. The default position is at the bottom
of the Network Drawing window.
3. To create a rule:
a. Choose a Result Feature
b. In the Design Rule group enter a name, a value and use the dropdown to specify
< or >=.
c. Click Add

October 2020
Results
Validating Results
The Rule is added to the Design Checklist table. The color of the rule indicates its
status:
o Red: At least one Node or Component fails the conditions of the rule for the
simulation selected.
o Green: All components and nodes meet the requirements of the rule for the
simulation selected.
o Gray: The Rule is selected and can be edited (step 4), deleted (step 5), or used to
collect components and nodes (step 6).
4. To edit a rule:
a. Click the Rule to select it.
The Rule is displayed as gray and the Design Rule group shows Cancel and Update
buttons.
b. Make any changes to the Result Feature, name, and value and use the dropdown to
specify < or >=.
c. Click Update
The changes to the rule are shown in the Design Checklist table and, if the updated
rule's status has changed, the rule color will update.
5. To delete a rule
a. Click the Rule to select it.
The rule is displayed as gray.
b. Press the Delete key.
A confirmation box is displayed, click Yes to confirm deletion. The rule is removed
from the Design Checklist table.
6. To collect components based on failed rules:
a. Click a failed (red) rule to select it.
Note
You cannot collect components and nodes on rules which have no failures.
The Collect button becomes active.

b. Click Collect
The components and nodes that failed the rule are collected in the Data tab of the
Network View pane (see “Collecting and Filtering Component and Node Results”
on page 418).

October 2020
Results
Accessing Results from the Project View Pane
Note
Existing collections of components or nodes are cleared when you collect items
by this method.
7. You can use the column filters to reduce the number of rules shown in the Design
Checklist table.
Results
The Network Result Validation rules are stored (under Documents in the Networks Project
View) as part of the Network and can be packed along with the Network and its other items.
Accessing Results from the Project View Pane

You can access results from the Project View pane.
Procedure
1. Open the Networks and navigate to the project and network that you want to view results
for.
2. Open the Results folder to see the individual result sets for the network:
Figure 11-4. Accessing Results from the Project View Pane
3. Open any result set by right-clicking on it and selecting Open Result.
Attaching Items to Results Sets

You can attach items, such as documents and image files to results sets.

October 2020
Results
Attaching Items to Results Sets
Table 11-5. document Types and Extensions

Document Type File Extensions
Adobe PDF .pdf
Crystal Report (Requires .rpt
Crystal Report Viewer)
Excel Spreadsheet .xls
HTML Document .htm
Notepad File .txt
PowerPoint Presentation .ppt
Rich Text Format .rtf
Word Document .doc or .docx
Image Files
Bitmap* .bmp
GIF* .gif
JPG* .jpg
PNG* .png
Video Files
Audio Video Interleave .avi
(AVI)
Procedure
1. Navigate to the result set that you want to attach the item to.

October 2020
Results
Deleting Result Sets
2. Open the required result set:

Figure 11-5. Attaching an Item to a Results Set
3. Right-click on the Documents folder and select Upload Document(s)

The Open dialog box is displayed.
4. Navigate to the file that you want to attach, select it and click OK to upload it.
5. To delete, inspect or update the document, right-click on it and select Open Document
for Inspection to view, Open Document for Update... to open the document for
editing, or Delete to delete the attached document.
Deleting Result Sets

Unless it has been protected, you can delete any Result Set, whether it is a Hybrid Result Set or
Checked-In to the Simcenter Flomaster Database.
For more information on Hybrid Result Sets see “Hybrid Results” on page 814
For more information on Protecting Result Sets see “Protecting Result Sets” on page 432.
Procedure
1. Click the Result Sets/Audit tab in the Network View pane.
2. Select the Result Set (or Sets) that you want to delete and choose Delete result set(s)
from the right-hand mouse button menu.
The Confirm Deletion dialog opens.
3. Select Yes or Yes to All.

October 2020
Results
Protecting Result Sets

You can sign off results sets and so protect them against edits or deletion.
Figure 11-6. Signed Off Results

• Only users with Administrator permissions are allowed to sign off results.
Procedure
1. Open the Result Sets/Audit and select the Result Set you want to protect.

October 2020
Results
2. To sign off a Result Set:

a. Click the button. A confirmation message is displayed. Also, the symbol next to
the results set changes as shown below:
3. To unsign a results set:

a. Click the button to display a series of confirmation messages.
b. Click OK. The symbol next to the signed off results changes as shown below:
Results
Signed off results can not be deleted. You must unsign the results set first.

October 2020
Results
Plotting Results
Plotting Results
You can display results as plots and plot two sets of results on the same axes to compare them.
Video
A video, Displaying and Plotting Results, is available.

Frequency Domain Processing and Fourier Transform Plots. . . . . . . . . . . . . . . . . . . . . 440
Fourier Transformation Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
The Results Plot Window

The Results Plot window is used to display results plots.
To display a results plot click the button. By default the plot is displayed in a floating
window but you can specify Docked, Tabbed, or Auto Hide by clicking the Window State
dropdown list and selecting an option:
Tip
Displaying the plot as a tabbed window makes it easy to switch between the Network and
Plot views.
Attaching Plots to Results Sets

You can attach a plot to a selected results set. This provides easy access to the plots (for
verification) and enables you to then make a change in a network, perform an overlay plot and
see the differences.
Procedure
1. With the plot window open, click the button to display the Select Network or Result
for Document dialog box.

October 2020
Results
Attaching Plots to Results Sets
2. Enter the document name.

3. Check the Result Set Specific option and select the required network from the
dropdown list.
4. Click OK.
The plot is added to the results set:

October 2020
Results
Integrating Plots - Worked Example

You can integrate the area under a plot. This example demonstrates how to do this for a simple
network with results.
Integrating Plots Example - Building the Network and Entering the Data . . . . . . . . . . 436
Integrating Plots Example - Running a Simulation on the Test Network . . . . . . . . . . . 438
Integrating Plots Example - Performing the Integration. . . . . . . . . . . . . . . . . . . . . . . . . 439
Integrating Plots Example - Building the Network and

Entering the Data
The first step of integrating a plot is to build the network and enter its corresponding data.
Procedure
1. Build the network shown below.
Figure 11-7. Integrated Plots - Example Network
2. Set the following component data.
Note
Only the data that is required is shown. All other data is either Not Set, or set to their
default values.

October 2020
Results
Component 1: Reservoir: Constant Head
Table 11-6. Component 1: Required Data

Pipe Diameter 0.2 m
Base Level above Reference 0 m
Surface Pressure 1.01325 bar
Component 2: Pipe: Cylindrical Elastic

Length 1000 m
Friction Data (Sub-Form)
Friction Option 1. Colebrook-White bar
Diameter 0.2 m
Wave Speed 1000 m/s
Component 3: Valve: Ball

Diameter 0.2 m
Valve opening 0.5 Ratio
Component 4: Reservoir: Constant Head

Pipe Diameter 0.2 m
Base Level above Reference 0 m
Surface Pressure 1.01325 bar

October 2020
Results
Component 5: Valve Opening: Tabular Controller

Output Quantity 17. Valve Opening m
1st Time 0 s
Valve Position at 1st Time 0.8 ratio
2nd Time 2 s
Valve Position at 2nd Time 0.1 ratio
3rd Time 8 s
Valve Position at 3rd Time 0 ratio
4th Time 20 s
Valve Position at 4th Time 0.8 ratio
Integrating Plots Example - Running a Simulation on the

Test Network
Run the simulation and make sure that there are no errors in the initial input data.
Procedure
1. With the Network window active, click the Simulation Data tab to see the General Data
and Simulation Control form.
In this example, we will be running two Transient simulations:
a. Select the Incompressible Transient option.
b. Set the following data:
Table 11-11. Running a Simulation on the Test Network

Time Step 0.01 s
Simulation Start Time 0
Simulation End Time 20
2. Click the Run button to start the simulation.

3. Once completed, run the simulation again to create a second set of results.

October 2020
Results
Integrating Plots Example - Performing the Integration

To perform the integration you need the results for both simulations.
In this example, we are going to look at the flow rate for Arm 1 for component 1, the Reservoir:
Constant Head.
Procedure
1. Click the Result Sets/Audit tab to display the results.
2. Highlight both sets of results and then click the Data tab.
3. Select the Results option and then select component 1 to display its properties in the
bottom pane.
4. Click in the cell next to Arm 1 Flow Rate and click the button.
A plot window opens showing the combined plot below:

Figure 11-8. Combined Integration Plot
5. Right-click on the plot line to display the Integrate dialog box.

October 2020
Results
Frequency Domain Processing and Fourier Transform Plots
Figure 11-9. The Integration Dialog Box
6. The dialog box has two sections.

• The 'Line Integration' section where you set the integration range for the 'X' axis.
• The 'Base Line Selection' section where you set the type of integration, and the fill
effect for the integration area.
Frequency Domain Processing and Fourier

Transform Plots
The Frequency Domain Processing options allow you to convert a plot into a frequency
spectrum plot. For example, converting a Flow Rate v Time plot into a frequency spectrum plot
of Amplitude v Frequency, or Power Spectrum plot (using Fast Fourier Transformation).
Time Domain Plots

Most plots are 'time domain' plots where the signal changes with time, such as a plot of
'Pressure v Time'. In some cases a plot of this kind is not sufficient to show the fine detail. Take
for example a complex waveform made up of multiple sinusoids of various frequencies. With a
plot of this type, it is often difficult to determine where the intervals to be measured begin and
end. Analyzing such complex waveforms requires a different approach, such a 'Frequency
Domain Processing'.
Frequency Domain Processing

A frequency domain plot shows how much of the signal lies within each frequency band, over a
range of frequencies. A frequency domain representation, also includes information on the

October 2020
Results
Fourier Transformation Calculations
phase shift that must be applied to each frequency to be able to recombine the frequency
components, so that the original time signal can be recovered.
Fast Fourier Transform

The aim of the Fast Fourier Transform, is to convert some arbitrary time signal so that it can be
represented as a frequency domain plot. In other words, we want to represent the signal as a set
of 'linear periodic functions'. Each periodic function can be represented by three properties:
amplitude, frequency and phase.
Related Topics
Fourier Transform Plots

To calculate the spectrum of a given continuous signal using Fourier Transformation
Simcenter Flomaster first uses the Continuous Fourier Transform.
(11-1)
Where:
Fw = Is the spectrum, w represents the frequency
fx = Is the signal in the time, where x represents the time
Since the signal is finite in time, the infinite borders of the integrals can be replaced by finite
ones, and the integral symbol can be replaced by a sum:
(11-2)
Where:
F(n) = The complex value of the Discrete Fourier Transform
f(k) = The signal in time for kth time step
N = The available number of points for transform

October 2020
Results
To calculate, Fn, the calculation has to be performed for every 'n' and every 'k'. The exponential
of the imaginary number can be replaced by a cos and a sin, by using the formula shown below:
(11-3)
For Fast Fourier Transform, the value of N (no of points considered for the transform) is 2m. 'm'
is calculated from the existing number of points:
m = nearest integer of (log (N)/log (2))
(11-4)
The above equation contains 'Real' and 'Imaginary' parts. Its amplitude for the nth term can be
calculated from the following equation:
(11-5)
A measurement of the power at various frequencies can be calculated from the following
equations:
(11-6)
(11-7)
Related Topics

October 2020
Results

The Fast Fourier Transform option enables you to convert a time plot, for example
Pressure v Time, into another plot.
The Fast Fourier Transform option lets you convert a time plot into one of the following:
• A frequency spectrum
• A power spectrum
For example, converting a plot of Pressure v Time into a frequency spectrum would give a plot
of Amplitude v Frequency. Converting the same Pressure v Time plot into a power spectrum
would give a plot of Power Spectrum v Frequency.

Converting the plot into an Amplitude v Frequency plot . . . . . . . . . . . . . . . . . . . . . . . . 443
Converting the plot into a Power Spectrum plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Converting the plot into an Amplitude v Frequency plot

You can convert an existing plot into an amplitude versus frequency plot.
Procedure
1. From the Tools menu select Fast Fourier Transform > Frequency Spectrum.
2. Re-select the feature and then click the button.
Converting the plot into a Power Spectrum plot

You can convert an existing plot into a power spectrum plot.
Procedure
1. From the Tools menu select Fast Fourier Transform > Power Spectrum.
2. Re-select the feature and then click the button.

October 2020
Results
Dashboards
Dashboards
The Dashboard tool is designed to help you to easily review transient simulation results for
complex networks during multiple simulations.
A video, Dashboards, which describes how to set up and use the Dashboard function to display
the results of multiple simulations is available:
Dashboards - Creating a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

Dashboards - Creating Plots of Component Values Versus Time. . . . . . . . . . . . . . . . . . 445
Dashboards - Creating Plots of One Component Value Versus Another. . . . . . . . . . . . 446
Dashboards - Working with Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Dashboards - Creating a Dashboard

You can create a Dashboard to help you see the changes in component results during transient
simulations.
• Any Dashboard that you create is specific to the Network that it was created in.
• You can only create one Dashboard per Network.
Procedure
With a network open in the Network Drawing window select Tools > Utilities > Dashboard to
open the Dashboard tool
Results
A blank Dashboard is created, onto which you can add plots of multiple component operational
variables versus time or each other.
For more information on creating plots for dashboards see “Dashboards - Creating Plots of
Component Values Versus Time” on page 445 and “Dashboards - Creating Plots of One
Component Value Versus Another” on page 446.

October 2020
Results
Dashboards - Creating Plots of Component Values Versus Time
Dashboards - Creating Plots of Component Values

Versus Time
You can add plots of Component Values versus Time to your Dashboard.
• You can use the dashboard to display component operational variables but not node
results or component branch results.
Prerequisites
• A network with at least one set of transient simulation results.
Procedure
1. From the Dashboard click the button.
The Create New Plot dialog box opens.

2. Use the radio button to Specify Value(s) vs Time.
3. Use the dropdown in the Define Series group to choose a component.
Tip
You can rename any result by entering a new name into the Series Name field.
4. Select a result to plot and click the button to display the plot.
Tip
For components with several results, you can filter the them by typing into the Series
Name field:
You can also choose the (Custom) option to open an advance search dialog box.
5. You can add multiple component results (from either the same component or by
choosing a new component) on the same plot by repeating steps 3 and 4.
Plotted results are shown in the bottom, left-hand pane (Plot Series) and a preview of the
plot is shown in the right-hand pane of the Create new Plot window .

October 2020
Results
Dashboards - Creating Plots of One Component Value Versus Another
a. You can edit or delete the plotted results by using the buttons.
a. As you create plots, Simcenter Flomaster will name them appropriately but you can
re-name them by entering a new name into the Title field.
6. Click the button in the bottom, right-hand corner of the dialog box to add the plot to
the dashboard.
Results
The plot is added to the Dashboard and the Create New Plot dialog box is cleared. You can
either close the dialog box or create another plot by repeating steps 2 to 6.
Dashboards - Creating Plots of One Component

Value Versus Another
You can add plots of one Component result versus another to your Dashboard.
• You can use the dashboard to display component operational variables but not node
results or component branch results.
Prerequisites
• A network with at least one set of transient simulation results.
Procedure
1. From the Dashboard click the button.
The Create New Plot dialog box opens.

2. Use the radio button to Specify Value vs Value.
3. Use the dropdown in the Define Series group to choose a component.
Tip
You can rename any result by entering a new name into the Series Name field.
4. Select a result to plot and click the button to display the plot.

October 2020
Results
Dashboards - Working with Dashboards
Tip
For components with several results, you can filter the values by typing into the
Series Name field:
You can also choose the (Custom) option to open an advance search dialog box.
5. Repeat step 4 to add a second component result.

Plotted results are shown in the bottom, left-hand pane (Plot Series) and a preview of the
plot is shown in the right-hand pane of the Create new Plot window.
a. You can edit or delete the plotted results by using the buttons.
b. As you create plots, Simcenter Flomaster will name them appropriately but you can
re-name them by entering a new name into the Title field.
6. Click the button in the bottom, right-hand corner of the dialog box to add the plot to
the dashboard.
Results
The plot is added to the Dashboard and the Create New Plot dialog box is cleared. You can
either close the dialog box or create another plot by repeating steps 2 to 5.
Dashboards - Working with Dashboards

Dashboards are Network specific (you can only have one Dashboard per network). If you copy
a network that has a Dashboard the Dashboard not is copied.
Procedure
1. Whenever the Dashboard is opened it reads the values of the latest results set. You can
refresh the values at any time by using the button.
2. For Networks with multiple results sets, you can specify the results set for the dashboard
by using the dropdown menu at the top-left of the dialog box to choose a results set and
then clicking the using the button.
3. You can use the slider at the top of the window to zoom in and out of the dashboard.

October 2020
Results
Air Conditioning Results - Plotting a P-h Diagram
4. You can zoom in and out of an individual plot by using the mouse scroll wheel or using
the mouse to select the area of interest in the plot.
5. You can view individual reults on any plot by holding the cursor over a plot line. The
value at that point is displayed in a pop-up box.
6. To add another plot see “Dashboards - Creating Plots of Component Values Versus
Time” on page 445 and “Dashboards - Creating Plots of One Component Value Versus
Another” on page 446.
7. To delete a plot click the button.
Air Conditioning Results - Plotting a P-h

Diagram
For air conditioning networks you can plot P-h diagrams which show the refrigeration cycle
(compression, condensation, expansion and evaporation) plotted on a Pressure-Enthalpy
diagram.

October 2020
Results
Air Conditioning Results - Plotting a P-h Diagram
Figure 11-10. P-h Diagram Example
A number of options are available when plotting P-h diagrams:

To Do this
Draw a P-h diagram 1. Click the Result Sets/Audit tab and select the required
results set. When you do this, the components
comprising the network are automatically loaded into
the Collection List, on the Data tab.
2. Click back on the Result Sets/Audit tab and then click
the button. The Plot window opens to display the P-
h Diagram Options dialog box.

October 2020
Results
Plot a Selected Feature Against Another Feature

To Do this
Plot a P-h diagram in Auto Note: In this mode, the plot is based on all the suitable
mode components in the component collection. If you are not
satisfied with the results, then you are advised to use the
Component Collection option, which enables you to select
specific components, or points in the network.
To do this, click the OK button. The P-h plot is displayed.
Plot a P-h diagram for 1. Click the Data tab followed by the Data radio button.
selected components 2. Remove any unwanted components from collection by
selecting them and clicking the button.
3. Click back on the Result Sets/Audit tab and then click
the Draw button.
The P-h diagram is displayed showing the refrigeration
cycle for the selected components.
Plot a P-h diagram with no 1. Uncheck the Labels option.
labels 2. Click the Draw button.
The P-h diagram is displayed with no labels.
Plot a P-h diagram with no 1. Uncheck the Close Loop option.
saturation line 2. Click the Draw button. The P-h diagram is displayed
When you choose this option, with no P-h curve.
the P-h curve is removed
from the diagram.
Plot a Selected Feature Against Another

Feature
You can plot one feature against another for components and nodes.
For components you can plot a selected feature against another component branch or node
feature, for all the components in the collection. For nodes, you can plot one node feature
against another node feature, again for all the nodes in the collection. For transient component
and node results, you can also plot Max/Min results or plot results for a specified time slice. For
air conditioning systems you can use the System Loop option to plot (for example) Branch
Enthalpy against Branch Flow Rate for the components in the loop.
Prerequisites
• The components to be plotted must be in a collection.
Procedure
1. Select the required component or node.

October 2020
Results
Plot a Selected Feature Against Another Feature
2. Select the required feature (e.g. Arm 1: Flow Rate).

For Min/Max transient results, select the required option. For time related events, click
the Time option button and enter a value in the adjacent field.
3. Click the button. The Draw Attribute dialog box is displayed.
4. Set the displayed result as the 'X' axis by clicking the associated check box.
5. Select the Related Attribute option from the dropdown list and then click OK.

October 2020
Results
Viewing Results Dynamically
Viewing Results Dynamically

For transient simulations you can view results, such as temperature and pressure, dynamically in
the Network Drawing window as color changes of components and via sensors which can
display results as text or as gauges.
Network Results Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Creating and Using Network Result Sensors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Network Results Display

For transient simulations you can view results, such as temperature and pressure, dynamically
as color changes of components, in the Network Drawing window.
Prerequisites
• A Network with associated Transient simulation results.
Video
A video, Visualizing Results in the Network Drawing Window, is available:
Procedure
1. With Network Results Display enabled, , you can display results for components and
nodes live, as a simulation progresses or for any saved results sets.
2. You can create videos of the Network Results Display simulations. To do this:
a. Click the Record annimation button, .
The simulation progresses.

Recording will continue to the end of the simulation or until you click the Stop
Annimation button, .
b. Videos are automatically stored in the Videos folder (typically: C:\Users\username\

Videos)

October 2020
Results
Creating and Using Network Result Sensors
Note
Any changes to simulation playback speed (including using the timeline bar to move
around the simulation timeline) or the Network Drawing window (such as zooming
in or out) will be recorded in the video.

You can use network result sensors to display the results for any components in the Network
Drawing window during playback (Network Results Display) of a transient simulation. You can
place multiple sensors on a network.
Prerequisites
• A Network with associated Transient Simulation results.
Procedure
1. Click the Add Network Sensor button, .
The Network Result Display pane and the Results Legend appear and a sensor is created
in the Network drawing window.
Tip
You can dock and undock the Network Result Display pane and reposition it. You
can also move the Results Legend around the Network Drawing window.
2. Click the Sensor to select it and drag the , , onto a component or node.
The Choose Result dialog opens showing the results available for the component that it
is linked to.
3. Select the result that you want to display. If required, you can also change the upper and
lower limits for the display. To reset the upper or lower limit values click either of the
buttons.
Note
The upper and lower display limits have no effect on the simulation or results, they
only effect how the result is displayed.
4. Click OK to close the Choose Result dialog.

October 2020
Results
The Sensor now displays the result you selected, in text, on the Network Drawing
window. During Network Results Display playback (see “Network Results Display” on
page 452) the sensor will continually update to display the current result.
Tip
You can drag and drop the sensor anywhere in the Network Drawing window.
5. You display the sensor's result in different formats by selecting Display as... from the
right-hand mouse button menu of the sensor and choosing a different display type.
Choose from:
Type Example
Label
Horizontal Linear Meter
Vertical Linear Meter
Dial Meter
6. You can change the feature (result) that any sensor is displaying by selecting
Change Feature from the right-hand mouse button menu of the sensor.

October 2020
Chapter 12
Pack and Unpack
The Pack and Unpack facility enables you to transfer a single network or multiple networks
associated with the project, together with any user-defined database items used by the
network(s) to another database, user or site. You cannot pack the project itself.
Packing Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Unpacking a Pack File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Packing Items
The Pack and Unpack facility enables you to transfer a single network or multiple networks
associated with the project, together with any user-defined database items used by the
network(s) to another database, user or site. You cannot pack the project itself.
Prerequisites
• The items that you want to pack must not be open or in use in an open network.
Procedure
1. From the Networks tab either:
• Right-click over the item that you want to pack
• Right-click over the project, sub-project, or network that contains the item(s) that
you want to pack
and select Pack.
The List of Items to Pack window is displayed. The left pane shows the items which can
be packed. The right-hand pane shows the properties for any item selected in the left
pane.
2. You can add more items to be packed by dragging individual items, networks, or
projects from the Networks pane into the List of Items to Pack pane.
You can use the + symbols to open and close nodes and see the contents of folders.
Note
You will not see any Simcenter Flomaster supplied items in list of items to pack.
Because this type of item is always available in Simcenter Flomaster those items
will be present where the pack file is unpacked.

October 2020
Pack and Unpack
Unpacking a Pack File
3. Use the check boxes to exclude any items that you do not want to be included in the pack
file.
4. To add a configuration to the pack file:
a. Click the Add Configuration... button to open the Select Configuration Set dialog
box.
b. Select a configuration and click OK.
The configuration is added to the List of items to Pack pane.
5. To add a unit set to the pack file:
a. Click the Add Unit Set button to open the Select Unit Set dialog box.
b. Select a Unit set and click OK.
The unit set is added to the List of items to Pack pane.
6. Click Pack To File...
The Write to pack file dialog box opens.
7. Navigate to where you want to store the pack file, specify a name for the file and then
click the Save button.
Results
A pack file (with the extension .FMPck) is created.
Related Topics

Pack files are used to transport customer created networks, units, components, performance
data, and configurations from one Simcenter Flomaster instance or user to another.
Prerequisites
• A pack file (.FMPck) stored on a local or network drive.
Procedure
1. From within the Networks tab navigate to the project that you want to unpack in to.
2. Right-click over the project and select Unpack.
The Open dialog box is displayed.
3. Navigate to the pack that you want to unpack and select it (pack files have a file
extension of .FMPck).

October 2020
Pack and Unpack
4. Click the Open button.

The List of items to Unpack dialog box opens. You can navigate through the items of the
pack file using the + and - buttons in the left-hand pane. When you choose an item in the
left-hand pane the properties are displayed in the right-hand pane.
5. Un-check any items that you do not want to unpack.
6. Specify what to do with duplicate items:
Select Use Existing to specify that, if there is an identical item in the target project that
item is retained.
Select Add New to specify that, if there is an identical item in the target project the new
item is added to the project. In this instance the new item will have a “+” at the end of
the name.
7. Specify what to do with identically named items:
Select Auto Rename to specify that Simcenter Flomaster renames any duplicate named
items. In this instance Simcenter Flomaster will add a “+” at the end of the item name.
Select Prompt to specify that Simcenter Flomaster asks you, during the unpack
procedure, to provide a new name for any duplicates on unpack
Figure 12-1. Duplicate Item Decision
8. Specify how the hierarchy of the pack file is replicated in the target project.
Check the Use Packed Hierarchy option to retain the hierarchy (the folder and sub-
folder structure of the pack file contents).
In this instance a notification message is displayed during unpacking. Select:
• Yes to continue

October 2020
Pack and Unpack
• No to unpack into the project selected in step 1

• Cancel to cancel the unpack.
You can choose the Don't show this message again check-box to suppress further
messages.
Note
You cannot use the packed file hierarchy for pack files created in Version 7.9.1 or
earlier.
You can manually specify the path of any of the items being unpacked:
• Select the item
• In the right-hand pane click the [...] button in the Path Value field to open the Path
Editor dialog box
• Enter a new path in the Item Path field
• Click OK to save and close the dialog box
9. Click Unpack.
Related Topics
Packing Items

October 2020
Chapter 13
AVL EXCITE
Simcenter Flomaster contains an AVL EXCITE Bearing Component that you can use to create
a bearing map from AVL EXCITE or AVL EXCITE Designer.
AVL EXCITE Bearing Component - Importing Data Files into Simcenter Flomaster 459
AVL EXCITE Bearing Component - Using Data Files . . . . . . . . . . . . . . . . . . . . . . . . . . 460
AVL EXCITE Bearing Component - Importing

Data Files into Simcenter Flomaster
If you have a new data file, or you have upgraded a network and you want to use the existing
data file(s) you must import them into Simcenter Flomaster.
You can import AVL EXCITE component data into Simcenter Flomaster.
Procedure
1. Using Windows Explorer, open the legacy FloMASTER .dtf folder to see all the data
files.
2. Open the file with a text editor program, choose all text and copy it to the clipboard.
3. In Simcenter Flomaster open the Catalogues tab.
4. Open Scripts > User-Defined catalogues.
5. Right-click on the Network catalogue and choose the New Catalogue option.
This creates a new catalogue which you can use to store your data files. It is advisable to
give this catalogue the same name as the upgraded network.
6. Right-click on the new catalogue and select New option to display the Scripts Option
dialog box.
7. Check the Structured Data option and click OK.
The Script Editor dialog box is displayed.
8. Paste the text into the space provided.
9. Click the cell next to Title and enter a file name.
10. Click OK.

October 2020
AVL EXCITE
AVL EXCITE Bearing Component - Using Data Files
Related Topics
AVL EXCITE Bearing Component - Using Data Files
AVL EXCITE Bearing Component - Using Data

Files
Simcenter Flomaster contains an AVL EXCITE Bearing Component that you can use to create
a bearing map from AVL EXCITE or AVL EXCITE Designer.
Procedure
1. Open the upgraded network that contains the AVL EXCITE Bearing component(s).
2. Add the components to the Collection List
3. Select the required AVL EXCITE Bearing component.
Its properties are displayed in the bottom pane.
4. Ensure that the Bearing Data File Format data item for the component is set to the
relevant Bearing Data File (BDF).
The file is generated by AVL EXCITE or EXCITE Designer. (Such a BDF will contain
lines starting with "#EXCITE" in the comment header.)
Note
Multiple bearings of the same size can share the same BDF, and all of them will be
updated with the geometry data stored in the BDF.
5. Click in the cell next to Bearing Input Data File to expose two buttons. Click the S...
button to display the Selection from Catalogue dialog box. The dialog allows you to
search the database for items, in this case Scripts.
6. Select a script.
7. Run a simulation. This will update components that contain #EXCITE data in the BDF.
Related Topics
AVL EXCITE Bearing Component - Importing Data Files into Simcenter Flomaster

October 2020
Chapter 14
Variable Parameters
Variable Parameters are a way of inputting data in a simplified form. For example, you could
set-up a series of parameters that varied the diameter of a pipe, or increased the speed of a
pump. They are most useful when investigating what is known as a 'Scenario', which is defined
as a 'sequence or development of events'.
In Simcenter Flomaster terms, this would be looking at a network and seeing what happened,
when for example the height of a reservoir above base was varied, or a valve was opened and
closed at the end of a long pipeline. In fact, a scenario can be any sequence of events that you
want to investigate further. To do this, you could set-up a range of variable parameters.
They are also useful when carrying out an 'Experiment', where you want to investigate the
differences in valve tolerances, or carry out a 'Parametric Study'.
Variable Parameters - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

Creating Input Variable Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Creating Output Variable Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Variable Parameters - Overview

All parameters must be entered in [ ] brackets. You can enter a parameter using a mixture of
lower-case or upper-case characters.
For example, to set the Pipe Diameter, you could enter the parameter as:
[pd1] or [pD1]
If you were entering the Orifice Diameter, then you would input the diameter as:
[od1] or [oD1]
You can also enter data as an expression. For example:
[k]/2
Where k is the loss coefficient. For more details about entering expressions see Entering
Expressions

October 2020
Variable Parameters
Creating Input Variable Parameters
You can add a suffix to a parameter. For example, if you are carrying out parametric studies and
you wanted to change the Pipe Diameter over a number of simulations, then you could set up a
range of parameters as follows:
[pd1a], [pd1b], [pd1c] and so on
Note
You can use set curves, surfaces, and equations using variable parameters.
You can create your own, custom curves in the form:
[Curve1]
Input Variable Parameters

You can use input variable parameters to specify a range of inputs. They are useful when
carrying out experiments on your networks to, for example, find the optimum pipe diameter.
You can apply input variable parameters to all components of the same type throughout your
network.
Output Variable Parameters

You can use output variable parameters to output a range of results for a specific output of a
given component. For example, you could use an output variable parameter to specify a range of
flow rates at a pump component output arm (for example: Pump Arm 2 Flow Rate). Output
variable parameters must be based on an existing output feature.
Unlike input variable parameters which can be used by different components, output variable
parameters can only be used to map a single result attribute for a component or node. They are
limited to 'real' values only.
To ensure they are 'single valued' in transient simulations, it is necessary to output them as
maximum, minimum or mean values for the duration of the simulation.

You use input variable parameters when running experiments.
Procedure
1. Open the Experiments tab from the Networks pane.
2. Click the Add button.
A new parameter, named [Parameter1], is added to the Input Parameter Name list and
the properties of the parameter are shown in the bottom pane.

October 2020
Variable Parameters
Creating Output Variable Parameters
3. In the bottom pane, edit the name of the parameter by entering the name of the
parameter between the [ ] brackets. For example, [pd1].
In addition to creating data-based parameters, you can specify performance data-based
parameters.
For example, a curve could be specified as [Curve1], an equation as [Equa1], and a
surface as [Surface1].
This would allow you to apply a range of time varying curves over a range of
simulations in a parametric study. The curve, equation or surface could be one supplied
by Simcenter Flomaster or one that you had created yourself.
4. Set the security level as required.
5. Specify the units by clicking in the cell next to Unit to expose a button. Click the button
to display the Unit Quantity Selector dialog box and select the required unit.
6. Enter an expression. See Entering Expressions.
7. You can also create input variable parameters from the component data form. To do this:
a. In the component data tab, click in the appropriate property’s value cell.
b. Enter an expression. See Entering Expressions
Note
When you create input variable parameters by this method the units are
automatically set for you. But, you still have to set the security requirements for each
parameter from the experiments tab (as in step 4 above).
Related Topics

You can create output variable parameters.
Procedure
1. From the network drawing window, right-click over the component that you want to
create a new output variable parameter for and select Create output Variable
Parameter.
The Output Parameter Creation dialog box opens.
2. Add a name in the Parameter name field.
3. Specify the transient analysis value by selecting either: Minimum, Maximum, or
Mean.

October 2020
Variable Parameters
4. Use the Assign Output Feature pane to navigate to and choose an output feature.
A confirmation message is displayed.
6. You can add more parameters by repeating steps 1 - 5.
7. When you have finished, click the Close button.
Results
The new output parameter variable is added to the existing output parameters.
You can view details of the output parameter variable by selecting the output parameter variable
in the middle pane: Details are shown in the bottom pane.
You can delete any output parameter variable by selecting it (in the middle pane) and clicking
the Delete button (a confirmation is displayed before deletion).
Related Topics

October 2020
Chapter 15
Experiments
An experiment is a set of defined input and output parameters, and one or more sets of
simulation results. An experiment can be the starting point for a simulation using Variable
Parameters.
Table 15-1. Video Topics Relating to the Experiments Functionality

Task Video
Creating Experiments
Running Experiments
The Results of Experiments
Parametric Studies
Latin Square Experiements
Monte Carlo Experiments
You can perform the following types of experiment:
• Parametric Study
• Latin Square
• Monte Carlo (with Box-Mueller, Marsaglia Polar, or Latin Hypercube distribution
types)
Creating an Experiment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Deleting an Experiment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Parametric Studies Experiments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

October 2020
Experiments
Creating an Experiment
Sequential Blocks Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

Constant and Sequential Blocks with Repeats Example . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Latin Square Experiments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Defining General Input Data for Latin Square Experiments . . . . . . . . . . . . . . . . . . . . . . . 475
Monte Carlo Experiments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Generating Input Data Monte Carlo Experiments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Reviewing Results of Experiments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Displaying Input and Output Parameter Details From the Results Tables . . . . . . . . . . . . . 480
Create Ad Hoc plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Exporting the results of an Experiment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Response Surfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Meta-Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Entering Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Exporting XML Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Fetching a Value From an External Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
An experiment is a set of defined input and output parameters, and one or more sets of
simulation results. An experiment can be the starting point for a simulation using Variable
Parameters. Simcenter Flomaster contains tools to help you create and manage experiments.
Prerequisites
• Create variable parameters and set their units and values (Variable Parameters).
You can set as many input parameters as you need, but you must set at least one output
parameter.
• Set the security levels for each parameter.
• Assign the parameters to the relevant components.
Procedure
1. Open the Experiments Tab on the Network View pane.
2. Click the Manage... button.
The Manage Experiment dialog box opens.
3. Enter a name for the experiment in the name field and use the Base experiment
dropdown list to choose an experiment type.

October 2020
Experiments
Deleting an Experiment
Select from
• Parametric Study (see Parametric Studies Experiments)
• Latin Square (see Latin Square Experiments)
• Monte Carlo (see Monte Carlo Experiments)
4. Click the Next> Button.
The Simulation Setup tab is displayed. The fields and settings on the Simulation Setup
tab depend upon the Base experiment type set in step in step 3.
Note
Until the simulation has been run, you can change the Base Experiment type from
the Simulation Setup tab. Once a simulation has been run this option is unavailable.
For information on defining instructions for:

• Parametric Study experiments see Parametric Studies Experiments
• Latin Square experiments see Latin Square Experiments
• Monte Carlo experiments see Monte Carlo Experiments
5. Click the Generate Input Data button.
Input data is created according to the parameters specified in Step 4.
Note
You can use the Import Input Data… and Export Input Data… buttons to import
or export XML compliant data.
6. Select theSave "Output parameter" results only option to limit the results to Output
Parameters or leave unchecked to save both Input and Output parameters.
7. Click Run.
Results
The simulations are run (the simulation status is shown in the Simulation window).
Related Topics
You can delete experiments and all the associated results, or delete the experiment and retain
the results.

October 2020
Experiments
Procedure
2. Click the Manage Experiments button.
The Manage Experiments dialog box opens.
3. Select the experiment that you want to delete.
4. Click the Delete button.
5. Specify if the results are also to be deleted and click Yes to confirm the deletion.
Related Topics

October 2020
Experiments
Parametric Studies Experiments

Parametric Studies are one of the types of experiment that you can run in Simcenter Flomaster.
Video
A video, Parametric Studies, is available.
For general information experiments see Creating an Experiment
You set Input Parameters from the Simulation Setup form. Patterns are entered as blocks of the
following types:
• Constant Blocks
• Sequential Blocks
You can set parameters as either:
• A start value and increment (as shown in the examples below)

• As a range of discrete values
Latin Square Experiments
Reviewing Results of Experiments
Sequential Blocks Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Constant and Sequential Blocks with Repeats Example . . . . . . . . . . . . . . . . . . . . . . . . . 474
Setting Up Parametric Studies

Parametric Studies are one of the types of experiment that you can run in Simcenter Flomaster.
This topic provides information on setting the Input Parameters (defining instructions) for
Parametric studies.
Prerequisites
• Set up an experiment and specify the type as Parametric Study (see Creating an
Experiment)
Procedure
Set the input parmeters.

October 2020
Experiments
Figure 15-1. Parametric Studies - Defining Instructions
All patterns are entered as either Constant or Sequential blocks.

You can mix patterns. For example, you could have a sequential block where the data
changed for 10 simulations and a constant block, where the data remains fixed for the 10
simulations. Examples of different methods provided below.
For more information on Constant and Sequential blocks see Constant and Sequential
Blocks Example and Constant and Sequential Blocks with Repeats Example.
Table 15-2. Example (a) - Constant Blocks

Pressure Source
Starting Value 1

October 2020
Experiments
Table 15-2. Example (a) - Constant Blocks (cont.)

Pressure Source
Increment 1
Block Size 3
Block Count 5
Pattern Repeats 1
Produces the following sequence of constant values
Figure 15-2. Example (a)
Table 15-3. Example (b) - Constant Blocks (Repeating)

Constant Blocks
Starting Value 1.9
Increment 0.9
Block Size 3
Block Count 2
Pattern Repeats 2

October 2020
Experiments
Sequential Blocks Example
Figure 15-3. Example (b)
Table 15-4. Example (b) - Constant Blocks (Repeating)

Constant Blocks
Starting Value 1
Increment 1
Block Size 3
Block Count 5
Pattern Repeats 1

Figure 15-4. Example (c)
Sequential Blocks Example

This topic provides an example of setting up a parametric study using sequential blocks as the
input parameter definition method.
In an experiment where you wanted to investigate the increase in pressure from 1 to 5 bar over 5
simulations, the pattern block would be as shown in the following table.
Table 15-5. Sequential Block - Example
Block 1
Pressure Source (bar) 1 2 3 4 5

October 2020
Experiments
Constant and Sequential Blocks Example
To do this enter the patterns as:

Table 15-6. Sequential Block - Example
Pressure Source
Status Instruction Set
Instruction Mode Sequential Blocks
Starting Value 1
Increment 1
Block Size 5
Block Count 1
Pattern Repeats 1
Constant and Sequential Blocks Example

This topic provides an example of setting up a parametric study using constant and sequential
blocks as the input parameter definition method.
In an experiment where you wanted to investigate a pressure increase from 1 to 5 bar whilst
varying a loss coefficient from 1 to 3 you would set the following.
• a pressure source incrementing from 1 to 5 bar in 1 bar steps with a loss coefficient of 1
Table 15-7. Constant and Sequential Block - Example

Block 1 Block 2 Block 3
Pressure Source (bar) 1 2 3 4 5 1 2 3 4 5 1 2 3 4 5
Loss Coefficient 1 2 3

Table 15-8. Constant and Sequential Block Pattern- Example
Pressure Source Loss Coefficient
Status Instruction Set Instruction Set
Instruction Mode Sequential Blocks Constant Blocks
Starting Value 1 1
Increment 1 1
Block Size 5 5

October 2020
Experiments
Constant and Sequential Blocks with Repeats Example
Table 15-8. Constant and Sequential Block Pattern- Example (cont.)

Pressure Source Loss Coefficient
Block Count 3 3
Pattern Repeats 1 1
Constant and Sequential Blocks with Repeats

Example
This topic provides an example of setting up a parametric study using sequential blocks with
repeats as the input parameter definition method.
In an experiment where you want to investigate a pressure increase from 1 to 5 bar whilst
varying a loss coefficient from 1 to 3, and a pressure source which varies between 1 and 2 bar
you would set the following.
Table 15-9. Constant and Sequential Block - Example
Block 1 Block 2 Block 3 Block 4 Block 5 Block 6
Pressure Source 123451234512345123451234512345
(bar)
Loss Coefficient 1 2 3 1 2 3
Pressure Source 1 1 1 2 2 2

Table 15-10. Constant and Sequential Block Pattern- Example
Pressure Source Loss Coefficient Pressure Source
Status Instruction Set Instruction Set Instruction Set
Instruction Mode Sequential Blocks Constant Blocks Constant Blocks
Starting Value 1 1 1
Increment 1 1 1
Block Size 5 5 5
Block Count 6 6 6
Pattern Repeats 1 1 2

October 2020
Experiments

Latin Square Experiments are one of the types of experiment that you can run in
Video
A video, Latin Square Experiements, is available.
When you create a Latin Square Experiment for each Input Parameter you must specify either:
• Lower and upper bounds

• A range of discrete values
Note
When using discrete values, the Latin Square values generated are repeated for each
combination of discrete values. For example, if 3 levels are selected, 9 simulations
are generated. Using 2 discrete input parameters, each with 3 values, will generate 9
combinations of discrete values and therefore 81 simulations in total.
Simcenter Flomaster then creates a distribution of values and the appropriate simulations. The
Latin Square algorithm ensures an even distribution of values and that the simulation results are
ideal for creating representative Meta-Models and Response Surfaces.

Defining General Input Data for Latin Square Experiments . . . . . . . . . . . . . . . . . . . . . 475
Defining General Input Data for Latin Square

Experiments
Latin Square Experiments are one of the types of experiment that you can run in
Simcenter Flomaster. When you create a Latin Square Experiment for each Input Parameter you
must specify either lower and upper bounds or range of discrete values.
Prerequisites
• Set up an experiment and specify the type as Latin Square (see Creating an Experiment)
Procedure
1. Use the Levels dropdown list to specify the number of levels.
Setting a higher number of levels will produce a greater number of simulations.

October 2020
Experiments
Defining General Input Data for Latin Square Experiments
2. Set either the lower and upper bounds or discrete values for all the input parameters.
Discrete values should be entered as a list of comma separated values, for example 0,
0.5, 1
3. Click the Generate Input Data button to generate the input data for each simulation.
Note
You can make changes to the lower and upper bounds and the number of levels and
regenerate the Input Data. Once the simulation has been run this option becomes
unavailable.

October 2020
Experiments

Monte Carlo Experiments are one of the types of experiment that you can run in
Note
You cannot create Response Surfaces from Monte Carlo Experiments.
Video
A video, Monte Carlo Experiments, is available.
When you create a Monte Carlo Experiment you specify:
• The total number of simulations to be performed

• The mean and sigma for each input parameter
• The lower and upper bounds for each input parameter
• The distribution type
There are four distribution types that you can use with Monte Carlo Experiments:
• Marsaglia Polar
• Box Mueller
• Latin Hypercube
• Custom - where you can specify the Calculates mean and sigma and the minimum and
maximum values for each parameter.
Generating Input Data Monte Carlo Experiments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Generating Input Data Monte Carlo Experiments

Use the following procedure to create a Monte Carlo experiment.
Prerequisites
• Set up an experiment and specify the type as Monte Carlo (see Creating an Experiment)
Procedure
1. Use the Distribution Type dropdown list to select the distribution type.

October 2020
Experiments
Generating Input Data Monte Carlo Experiments
2. Use the Number of simulations field to set the number of Simulations.

3. Set the Mean and Sigma values for all the input parameters.
4. You can restrict the scope of any parameter by setting Lower or Upper Bound (as either
absolute or normalised values). Bounds are not mandatory fields. Bounds and the
Normalised Bounds are related: Entering a value in one field will automatically update
the other.
Note
Simulations are restricted to values not greater than and not less than 4 x Sigma from
the Mean. Setting bounds outside this value has no effect upon the generated input
data.
5. Click the Generate Input Data button to create the input data.
Note
You can make changes to the mean, sigma, lower and upper bounds, and the number
of levels and regenerate the input data. Once the experiment has been run this option
becomes unavailable.

October 2020
Experiments

You can view a previously run experiment and export the results.
Displaying Input and Output Parameter Details From the Results Tables . . . . . . . . . . 480
Create Ad Hoc plots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Exporting the results of an Experiment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Response Surfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Meta-Models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Viewing the Results of an Experiment

You can view an experiment’s results after opening it.
Procedure
2. Click the Manage Experiments button.
The Manage Experiments dialog box opens.
3. Select the Open Experiment option and select the experiment you want to open by
clicking on it.
4. Click Next> to open the experiment.
5. Open the Results View by clicking the View Results tab.
The results are displayed.
6. You can choose how to display the results;
Table 15-11. Viewing the Results of Experiments

Data and Results Input data and simulation results are displayed.
Results Only simulation results are displayed.
Hide Repeated Values Any identical input data or simulation results are not
displayed.

October 2020
Experiments
Displaying Input and Output Parameter Details From the Results Tables
Table 15-11. Viewing the Results of Experiments (cont.)

Toggle Orientation Switches the orientation of the simulation results and, when
displayed, input parameter tables. When both the results
and input parameter tables are displayed the Toggle
Orientation button also switches the simulation results
tables from left/right to top/bottom panes.
Start From Sim No. Use these fields to reduce the amount of data displayed
when working with long lists of results
Display Sims
Shift
Synchronise Scrolling Use this field to scroll through the input data and simulation
results together. This is useful when displaying long lists of
data. (This field is unavailable when displaying simulation
results only)
Note: You can clear any Start From Sim No., Display Sims, and Shift filters by
checking the Display All check box.
Displaying Input and Output Parameter Details

From the Results Tables
You can display the usage of any Input Parameter and the properties of any Output Parameter
from the results tables.
Procedure
1. If not already set to display, select Data and Results to show the Input Data Parameters
table.
2. Right-click over the Input Parameter that you want to view the usage of and select Show
Usage from the menu. The Input Parameters Usage dialog box, which displays
parameter usage, opens.
3. To view Output Parameter properties, right-click over the Output Parameter that you
want to view the properties of and select Show Parameter Property from the menu.
The Parameters Properties dialog box, which displays parameter properties, opens.

October 2020
Experiments
Create Ad Hoc plots
Create Ad Hoc plots

You can create 2D and 3D plots of Input or Output parameters, 2D plots of Input/Output
Parameters versus Simulation number, and Graphs of the Time History of Output Parameters
from the results of experiments.
Creating Ad Hoc Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Creating Ad Hoc Plots

You can create 2D and 3D plots of Input or Output parameters, 2D plots of Input/Output
Parameters versus Simulation number, and Graphs of the Time History of Output Parameters
from the results of experiments.
Prerequisites
• An open experiment with results (see Creating an Experiment and Viewing the Results
of an Experiment).
Procedure
1. In the results table, right-click over a parameter and click Select X Axis Data.
2. Then:
For a 2D graph:
a. Right-click over a second parameter and click Select Y Axis Data and Plot. .
A 2D plot of the parameters is displayed in a new window
For a 3D graph:
a. Right-click over a parameter and click Select Y Axis Data.
b. Right-click over a parameter and click Select Z Axis Data and Plot.
A 3D plot of the parameters is displayed in a new window.
To create a plot of parameters against simulation numbers:
a. Right-click over a parameter and select Plot against Simulation Number.
A plot of the parameter against the simulation number opens in a new window.
To create a plot of a result’s time history:
a. Right-click over an output parameter and click Plot Time History.
Note
This plot type is only suitable for transient simulations. Where no history data is
available an error message is displayed.

October 2020
Experiments
Creating Output Expressions
A plot of the parameter against time is displayed in a new window.
Creating Output Expressions

You can create Output Expressions for Output Parameters. Output Expressions can be used to
plot the ratios of individual Output Parameters. For example, the Ratio of Flow to Speed v
Pump Flow Rate.
Prerequisites
• An open experiment with results (see Creating an Experiment and Viewing the Results
of an Experiment).
Procedure
1. Right-click over an output parameter and select New Output Expression....
The Expression Builder for Output Parameters dialog box opens.
2. Enter a name for the expression in the Parameter Name field.
3. Select a unit quantity for the expression by clicking the [...] button.
The Unit Quantity Selector dialog box opens.
4. Choose a unit and click OK. The Unit Quantity Selector dialog box closes.
5. Enter the expression in the lower field.
Note
Guidance on building expressions is given in the yellow section of the Expression
Builder for Output Parameters.
6. Click OK to append the expression to the Output Parameter Name table.

7. You can edit and delete Output Expressions by selecting Edit Output Expression....
Exporting the results of an Experiment

You can export the results of an experiment as a character-separated values (CSV) file or XML
file.
Procedure
1. To export a CSV file:
a. From the View Results tab click the Send… button.
The Send Instructions Dialog Box opens.

October 2020
Experiments
Exporting the results of an Experiment
b. Specify which data to include, the Name and Folder location, and which character to
use as the delimiter for the CSV file. You can also specify the program used to open
the file.
c. Click OK.
The file is saved to the Folder (path) you specified.
2. To export an XML file:
a. From the View Results tab click the Save to XML… button.
The Export XML dialog box opens.
b. Specify which data to include.
c. Click OK.
A write to xml file dialog box opens.
d. Specify the name and location for the XML file and click Save.
The XML file is saved in the specified folder.

October 2020
Experiments
Response Surfaces
Response Surfaces
A Response Surface is a 3D representation of two selected input parameters plotted against an
output parameter. Response Surfaces can be generated from the results of a Parametric Studies
or Latin Square Experiments.
The Response Surface is generated by applying a radial function to results sets to create Meta
Models and by then selecting two inputs and an output. A response surface can be evaluated for
goodness-of-fit and refined by applying a new radial function or by running more simulations.
A Response Surface can be examined for goodness-of-fit by viewing the Absolute or

Percentage Deviations. These are calculated as the difference between a results point and an
interpolated point derived from the fitted curve.
Deviation data (minimum, maximum, and average) is displayed on the Response Surface view,
below the 2D results graphs.
Note
You can toggle between displaying the deviation values as Percentages or Absolute values
by using the Percentage and Absolute buttons.
Creating a Response Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

Change the Response Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Viewing the Deviation Details for a Response Surface. . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Creating a Response Surface

You can response surfaces for experiments which have at least two input and one output
parameter and are either Latin Square or Parametric Study experiment types.
Prerequisites
• An open experiment (Latin Square or Parametric Study) with results (see Creating an
Experiment and Viewing the Results of an Experiment).
Procedure
1. Open the Response surface view by clicking the Response Surface tab.
2. You can open any previously saved Meta-Models by selecting the appropriate model
from the Meta Models dropdown list. Otherwise, the default model for the experiment
will be used.
3. For experiments where multiple series of simulations have been previously run, you can
use the Levels dropdown list field to select the number of levels to be used for the
surface.

October 2020
Experiments
Response Surfaces
4. Choose a Radial Function from the Radial Function dropdown list. Select from:
• Gaussian
• Duchon's
• Hardys
• Inverse MultiQuadrics
• All - (When you select this option, Response Surfaces for all Radial Functions are
created and the Surface with the lowest deviation value is displayed. This option is
useful when investigating the suitability of Response Surfaces using the Deviation
Details option)
Note
The number of successful simulations for the selected Meta Model is displayed
below the Radial Functions field. Failed Simulations are not used in the
generation of Response Surfaces.
5. Choose any two Input Parameters. Input parameters may be Continuous or Discrete.
• Continuous Input parameters are displayed as a slider in the Continuous Input
Parameters section. Use the check box to select the Continuous Input Parameters and
the slider to change its value.
• Discrete Input parameters are displayed in the Discrete Input Parameters section.
Click the required value to select it.
Note
Simcenter Flomaster will automatically determine which of your parameters are
Continuous and which are Discrete and display them on the Response Surface
form in the appropriate manner.
6. Choose an Output Parameter by clicking on it.

7. Click Display. The response surface and 2D plots of each of the selected Input
parameters and the selected Output Parameter are displayed. You can make changes to
any of the parameters used to create the Response Surface and see the effects by clicking
the Display button again.
Change the Response Surface

Response Surfaces are, by default, displayed as orthogonal graphs but you can choose to view
the data as a 2D graph.

October 2020
Experiments
Response Surfaces
You can move, rotate, zoom, apply lighting effects and export (as an image) Response Surfaces
by using the following tools:
Table 15-12. Changing the Response Surface
Use this button to display the Response Surface as a 2D graph
Use this button to display the Response Surface as an orthogonal
(3D) graph
Use this button to select one of the pre-defined projections
Use this button to open the Chart Image Export dialog box. From
here you can specify the quality, file format, and size of an image
of the Response Surface to be exported
Use these buttons to re-size the x, y, and z axes
Use this button to select different lighting schemes
Select this option to use the mouse to move the graph within the
plot window
Select this option to use the mouse to rotate the orthogonal graph
within the plot window
Select this option to use the mouse to zoom in and out of the graph
Select this option to disable the mouse in the plot window
Viewing the Deviation Details for a Response Surface

You can display the deviation data graphically or use the Deviation Details window which gives
you an overview of the differences in Response Surfaces for each type of Radial Function.
Procedure
To view the deviation details either:
• Click the 3D Deviation... button.

The deviation details are displayed as a graph in a new window
• Click the Deviation Details... button.
The Deviation Details window is displayed.

October 2020
Experiments
Response Surfaces
Note
The Deviation Details window will only display data for Response Surfaces that
have previously been generated. For example, if you have only previously generated
surfaces using the Gaussian and Duchon's Radial Functions you will not see data for the
Hardys and Inverse MultiQuadrics Radial Functions.
The Deviation Details Window is divided into 4, re-sizable panes:
Table 15-13. The Deviation Details Window

The Data Table Pane The data table pane displays the maximum, minimum, and average
deviations for each radial function type. You can switch between
displaying the deviation data as percentages or absolute values by
using the Percentage or Absolute buttons.
Note: The Percentage and Absolute buttons also switch the
Bar chart and Deviation Surface graphs between Percentage
and Absolute.
The Deviations Bar Displays the maximum, minimum, and average deviations as a bar
Chart chart. You can use the check boxes at the top of the pane to
simplify or add more data to the graph.
The Response Displays surfaces using the radial function selected in the data table
Surface Graph pane.
The Deviation
Surface Graph

October 2020
Experiments
Meta-Models
Meta-Models
Meta-Models contain all results sets, the defined inputs, a single output parameter, and a radial
function for a set of simulations that have been derived from creating either a Parametric Study
Experiment or a Latin Square Experiment.
Meta-Models can be saved and exported as C code or as S-Functions, both of which are suitable
for use in a real time simulation environment to characterize a Simcenter Flomaster system
response. This is useful, for example, in hardware-in-the-loop testing of control systems design.
Note
Response Surface and Meta-Model generation is available for steady-state analyses only.
Working with Meta-Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Working with Meta-Models

You can save, export (as C code or as an S-Function), and delete Meta-Models.
Procedure
1. To save a Meta-Model:
a. Enter a name in the Meta-Models field and click the Save button
2. To export the Meta-Model:
a. Open the Export Model Dialog Box by Clicking on the export button.
b. Select either:
o C Code
o S Function
o FMU V1.0 Model Exchange
o FMU V2.0
Note
If FMU V2.0 is selected the resulting FMU will support FMI V2 standard for
model exchange and co-simulation.
c. Enter a File Path in the File Path field (or click Browse to browse to a location).
d. Click OK.
3. To delete a Meta-Model:
a. Click the Delete button

October 2020
Experiments
Entering Expressions
You can enter a variable parameter as a mathematical expression.
For example:
• [Height] * [Width], or
• Math.PI * [Diameter]*[Diameter] / 4.0
Note
You can only enter expressions for 'real' parameters such as Diameter, Length, Flow
Area.
Procedure
1. From theExperiments tab click the Add button.
Clicking the Add button in the Input Parameters pane creates a new input parameter.
Clicking the Add button in the Output Parameters pane created a new output parameter.

October 2020
Experiments
2. Select the parameter and then Click in the cell next to Expression to expose a button.
Click the button to display the Expression Builder dialog box:
Figure 15-5. The Expression Builder Dialog Box
The yellow section shows some examples of how you can enter expressions.
3. To enter an expression, click in the bottom pane and enter the details. For example:
[k]/2
Where: [k] the loss coefficient is divided by 2.
4. To evaluate the expression, click the Evaluate button. A message dialog box is
displayed showing the result.
Note
Parameters must be entered in [ ] brackets.

October 2020
Experiments
Exporting XML Data
Exporting XML Data

You can export XML data for use in other programs, such as Excel. The procedure shown
below relates to the use of Excel 2007. The procedure may be different for earlier versions of
Excel.
Procedure
1. Open Excel.
2. Ensure that you have the Developer tab displayed.
3. Click the Developer tab and then Source to open the XML Source window.
4. Click the XML Maps button to display the XML Maps dialog box.
5. Click Add to display the Select XML Source dialog box.
6. Load the 'VpSchema.xsd' file (that is used to validate the XML file).
7. Select the file and then click OK to close the XML Maps dialog box. The XML source
data is loaded the window as shown below:
Figure 15-6. The XML Source Dialog Box

October 2020
Experiments
Fetching a Value From an External Database
8. Click the Variable Parameter folder to highlight its contents as shown above, and then
drag it into the work sheet. Doing this will create a table header as shown below:
Figure 15-7. The Table Header
9. Click Import to display the Import XML dialog box. Navigate to where the saved XML
file is stored.
10. Select the file and click the Import button. The data is added to the table as shown
below:
Figure 15-8. The XML Source Table
11. Save the imported data as an Excel Workbook.

You can use Simcenter Flomaster to access an external database and retrieve a value from a
previously stored procedure.
This example shows how to retrieve a value from the table, for Group Text 'ABC' and then use
it to set the length of a pipe component.
Procedure
1. Set up a variable parameter called Pipe Length by:
a. Clicking the Experiments tab and then clicking the Add New Parameter button.
b. Clearing the Read Only check box.

October 2020
Experiments
c. Clicking in the cell next to Name and entering the parameter name [Pipe Length].
d. Clicking the cell next to Security Level and setting the required security level.
e. Clicking the cell next to Unit to expose a button then using it to display the Unit
Quantity Selector dialog box and then selecting the required unit.
2. Click in the cell next to Expression to expose a button use it to display the Expression
Builder for Real dialog box.
3. Select the Fetch value from external database option. The view changes to show the
Database form.
4. Complete the fields as shown below:
Table 15-14. fetching a Value from an External Database

Field Description
Data source The location of the SQL Database. This can be:
• The SQL Server Management Studio Express that runs on a
colleagues desktop
• A full SQL Server (e.g. SQL Server 2005) that you access via
your network
If you are using SQL Server Management Studio Express you must
enter the name as shown in the example below:
CONWY\SQLEXPRESS
If you are using a full SQL Server you must define the full path
name of the database.
DataBase Name The name of the database you are accessing. For example:
WidgetEnterprises
Stored Procedure The name of the Stored Procedure you are accessing in the
Name database. For example: dbo.widgetdata
Include 'Group' text You can use this field to include any Group text that has been
as Stored Procedure included on the component sub-form.
Argument In this example, click Yes to specify "retrieve a 'Group' text value".
Include 'Type' text as Use this field to include any Type text that has been included on the
Stored Procedure component sub-form. In this example set this to No.
Argument
Include 'Title' text as Use this field to include any Title text that has been included on the
Stored Procedure component sub-form. In this example set this to No.
Argument

October 2020
Experiments
Table 15-14. fetching a Value from an External Database (cont.)

Include 'Field' text as Use this field to include any Field text that has been included on the
Stored Procedure component sub-form.
Argument In this example, click Yes to retrieve the relevant value for Length
from the table.
Extra Stored You can use thee three fields to enter additional arguments.
Procedure argument
1, 2 or 3 - blank
5. Click the Fetch Value button to display the Database Connection Test Data dialog box.
You will see that Group Text is 'ABC' and Field Text value is 'Length'.
6. Click OK to fetch the value. The Fetch Result dialog box is displayed showing the
result.
7. Apply the parameter to the Pipe as follows:
a. Click the Data tab then select the Pipe to display its properties.
b. Right-click the cell next to Pipe Length and select the Select from matching Variable
Parameters option to display the Select Variable Parameter dialog box.
c. Select the parameter and click OK.

October 2020
Chapter 16
Cavities
Gas turbines contain passage-ways in which air is transported for cooling purposes. These
passages are formed by rotating and stationary disks. You can use the cavity component to
model these passages.
Cavity Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Cavity Modelling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
The Cavity Configuration Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
Using the Cavity Configuration Wizard - Dividing the Cavity . . . . . . . . . . . . . . . . . . . . . 502
Rearranging the External Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
Specifying Face Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Viewing the Cavity Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Viewing the Individual Cell and Face Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

October 2020
Cavities
Cavity Configuration
Cavity Configuration
Within the rotating components comprising a gas turbine, there are many passage ways in
which the air is transported for cooling purposes. These passages are formed by rotating and
stationary disks. you can use the Cavity component to model the passage, or space that is
formed between these disks.
Figure 16-1 shows a cross-sectional view of a section taken from a turbine, that shows a cavity:
Figure 16-1. Cavity Example
Cavity Modelling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

Cavity Modelling
Simcenter Flomaster models a cavity by breaking it up into a number of discrete cells. Each cell
can have a number of fluid faces and solid faces. The fluid faces are the interfaces with the other

October 2020
Cavities
Cavity Modelling
cells and provide the connections to the rest of the network. The solid faces represent the 'non-
arm' faces of the cell.
.
You must set the relevant friction data for the solid faces
Figure 16-2 shows how the cavity is divided into a number of cells and how the faces are
defined.
Figure 16-2. How a Cavity is Divided into Cells
There is a wizard that guides you through the process of creating a cavity.
External and Internal Connections

Cavities have external and internal connections.

October 2020
Cavities
Cavity Modelling
External Connections
The number of external connections depends on the type of cavity you are creating.Figure 16-2
shows a cavity with two external connections, while Figure 16-3 shows a cavity with four
connections.
Figure 16-3. Four-arm Cavity
The following terminology is used to distinguish the different connection types:
• External Connections - these connections are shown in red. They always lie in the
middle of a face as shown above.
• Side Connections - these connections are shown in blue. They always lie at the end of a
horizontal grid line and connect to an internal node, as shown above.
Internal Connections
Internal connections are automatically generated when you finish creating a cavity.
Related Topics
Creating a New Cavity Component
Drawing the Cavity
The Cavity Configuration Wizard

October 2020
Cavities

You can create a new cavity component either by using one of the supplied blank components,
or by using one of the supplied analytical models. When using analytical models, you can
customize the model by setting default options and data values.
Simcenter Flomaster contains the following blank cavity components:
• Rotating Cavity 2-Arm

• Rotating Cavity 6-Arm.
These components have no data set and no underlying cavity and cell structure. You will first
need to: (i) draw the cavity and then (ii) configure the cavity by using the facilities provided by
the Cavity Configuration Wizard.
You can find these blank components by clicking the Catalogues tab to see all the available
catalogues, and then opening the Components catalogue followed by Gas Turbine\Secondary
Air\Cavity.
Simcenter Flomaster contains the following specialized components:
• Cell 2-Arm - this component is used to make-up the cavity. All cavities comprise a
number of discrete cells.
• Faces - these components are used to make-up the faces of the cells. Cells have fluid
faces and solid faces. Simcenter Flomaster contains the following faces:
o Fluid Face
o Rotating Cylinder Smooth Face
o Rotating Disk Smooth Face
o Zero Flow Smooth Face
It is important that you choose the correct cavity analytical model because after the cavity has
been created, you can no longer:
• Add or change the number of connections.

• Add a component or node to the cavity.

October 2020
Cavities
Procedure
Decide whether you want to use a blank component model or an analytical model, and continue
as described in Table 16-1
Table 16-1. Configuring a New Cavity Component

If you want to Do the following
Use a Blank Component 1. With the Network Window open navigate to the Cavity
Model catalogue.
2. Drag the required blank component into the drawing area.
3. Right-click the component symbol. The Cavity View Choice
dialog box opens.
4. With the Network option selected, click OK to open the

Composite Component window for the component. This is
similar to the Network Drawing window in that it enables
you to draw the cavity, set the required data for the cells and
the cell faces, and look at the component connections.
Use an Analytical Model 1. Open the Components catalogue, right-click the User
Defined catalogue and then choose the New Component
option to display the Selection from Catalogue dialog box.
2. Select the Filter All Catalogues option to display all the
available models.
3. Scroll down the list and select the required model.
4. Click Select. The component is added to the catalogue and
the Composite Component window is displayed. This is
similar to the Network Drawing window in that it enables
you to draw the cavity, set the required data for the cells and
the cell faces, and look at the component connections.
Results
The cavity component is created.
Related Topics
Cavity Modelling
Drawing the Cavity

October 2020
Cavities
Drawing the Cavity
Drawing the Cavity

When creating a new cavity you must define the outer limits (the shape) of the cavity.
Prerequisites
• It is recommended that you use a background image of the cavity as a template and use
it to trace the cavity outline. See Schematic Configuration Dialog Box - Importing
Background Imagesfor details of how to set a network background image.
Procedure
1. Double-click on the cavity component.
The Cavity View Choice dialog box opens.
2. Choose the Network option and click OK.
A new tab on in the network drawing window opens. From here you create the cavity.
3. Right-click and choose the Draw Cavity option.
4. Choose a starting point, and then move the mouse to the next point and left-click.
5. Continue around the perimeter of the cavity until you have created the required shape.
When you have finished, press the 'Rtn' key.
Note
Do not trace around bolt heads and other protrusions that you want to use in the
simulation. Trace through the base (as shown below)
Related Topics
Cavity Modelling

October 2020
Cavities

Use the Cavity Configuration Wizard to configure a cavity. You access this by clicking-in the
cavity and selecting the Divide Cavity option.
The wizard comprises the following pages:
• Select Rows - this form is used to divide the cavity into the required number of
horizontal cells.
• Rearrange Grid Lines - this form can be used to rearrange the grid lines (if required).
• Rearrange External Connections - this form can be used to rearrange the external
connection points. These are the points where the cavity connects to other components.
• Specify Default Face Types - this form is used to define the face types. As the cavity can
be used to represent the space between turbine blades, the face type represents the
interface between the cavity and the surrounds.
• Specify Face Types - this form enables you to further specify the face type. The form
also displays:
o The default face types and their associated colors.
o The number of faces comprising the cavity, plus dropdown list for each face from
where you can choose an alternative face.
The actions to perform with the wizard are described in the following topics.
Cavity Modelling
Drawing the Cavity
Using the Cavity Configuration Wizard - Dividing the Cavity . . . . . . . . . . . . . . . . . . . . 502
Rearranging the External Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
Specifying Face Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Using the Cavity Configuration Wizard - Dividing

the Cavity
Use the cavity configuration wizard is to divide the cavity into the required number of
horizontal and vertical cells.

October 2020
Cavities
Using the Cavity Configuration Wizard - Dividing the Cavity
Procedure
1. Right-click in the cavity and choose the Divide Cavity option. The configuration wizard
opens, displaying the Select Rows form.
2. To set the number of rows, click the dropdown list and select the required value.
3. Click Next.
4. To add a horizontal grid line either:
a. Place the cursor between two grid lines, at the point where you want the new line
b. Right-click and choose the Insert Horizontal Grid Line option. The new grid line
is added as shown below:
Note
As you add grid lines, they are automatically renumbered sequentially from top
to bottom. This is important to note, if you are using EDIF to update the data.
5. To add a vertical grid line either:

a. Place the cursor in the segment that you want to divide, and then click the
button.
b. Right-click and choose the Insert Vertical Grid Line option. This will create a
vertical split in the selected segment, as shown below:

October 2020
Cavities
6. To move a horizontal, vertical grid line or vertex:

a. Click the grid line to highlight it and drag it to the required location.
7. To delete a grid line, select the required line and then press the Delete button.
8. To add a vertex or a point:
a. Right-click a face to display the Add Point menu.
b. Select to Add Point or Insert Grid Line.
9. To delete a vertex:
a. Click the cavity to highlight all the vertices.
b. Right-click on the vertex you want to delete and choose the Delete Point option.
10. To move the cavity:
a. Right-click the cavity to display the dropdown list and ensure the Movable option is
enabled.
b. Click the cavity and drag it to its new position.
11. To add a horizontal grid line:
a. Place the cursor between two grid lines, at the point where you want the new line
b. Alternatively, right-click and choose the Insert Horizontal Grid Line option. The
new grid line is added as shown below:
Note
As you add grid lines, they are automatically renumbered sequentially from top
to bottom. This is important to note, if you are using EDIF to update the data.

October 2020
Cavities
12. To add a vertical grid line:

a. Place the cursor in the segment that you want to divide, and then click the
button.
b. Alternatively, right-click and choose the Insert Vertical Grid Line option. This will
create a vertical split in the selected segment, as shown below:
13. To move a horizontal or vertical grid line:

a. Click the grid line to highlight it and drag it to the new location.
14. To delete a grid line, select the required line and then press the Delete button.
15. To add a vertex or a point:
a. Right-click a face and select Add Point.
16. To delete a vertex:
a. Click the cavity to highlight all the vertices.
b. Right-click on the vertex you want to delete and choose the Delete Point option.

October 2020
Cavities
Rearranging the External Connections
17. To move a vertex:

a. Click the cavity to highlight all the vertices:
b. Select the required vertex and drag it to its new position.

As you move a vertex, the coordinates shown in the Cavity Vertices Data pane are
updated accordingly.
18. To move the cavity:
a. Right-click the cavity to display the dropdown list and ensure the Movable option is
enabled.
b. Click the cavity and drag it to its new position.

Use the Rearrange External Connections form of the wizard to rearrange the external
connection points (where you can make connections to other components) on a cavity.

October 2020
Cavities
Figure 16-4. The Rearrange External Connections Form
The form has three panes. The left pane with the graphical view displays the cavity divided into
the specified number of cells, plus their associated cell numbers (shown in blue). Also shown
are the connections, of which there can be two types:
• Radial Arm Connections - these are termed 'locating' arms and have the following points
associated with them:
o They are always located at the center of a face, in the radial flow direction.
o The connection points are shown in red and have a number associated with them.
o Flow can be in a positive or negative direction, similar to standard
Simcenter Flomaster components. Flow into the component from Arm 1 is
considered to be in the positive flow direction.
• Axial Side Arm Connections - for cavities that have connections on the vertical edges,
such as through orifices where flow is entering or exiting the cavity in the axial
direction, it is necessary to create a Side Arm Connection. They have the following
points associated with them:
o This type of connection is always displayed on the end of a horizontal grid line and
is shown in blue.
o You can only create side arm connections for cavities that have more than two
connections.
The Cavity Cell Information pane comprises a table that displays the Cell IDs and their
associated number of faces. If you choose a cell, say Cell 2, its coordinate data which is

October 2020
Cavities
displayed in the Cell Face Information table is updated accordingly. Also, the corresponding
cell is highlighted on the cavity.
The Cell Face Information pane comprises a table that displays the following information for
each cell displayed in the top table:
• The face ID.

• The X and Y coordinate data for the Point 1 and Point 2 of each face.
If you choose a face, then the corresponding face is highlighted on the cavity.
There are certain rules that govern how connections are made. They are discussed as follows
1. An external connection is always connected to a cell arm.

2. A side connection always connects to a node.
3. A connection is made between two adjacent cells only when there is at least one
common horizontal face between them. As recirculation is not being modeled, it is
assumed that flow will not occur between vertical faces. So, there is connection between
cells that share vertical faces. The following figure shows an example:
4. There is no flow through faces that lie on the cavity outline, except for faces that have
external connections.
5. A cell must have two connection levels. A connection level is a distinct 'Y' coordinate
value on the horizontal face or external connection. If the cell has more of less than two

October 2020
Cavities
connection levels an error message is displayed. The following figures show some
examples:

October 2020
Cavities
6. If there are two vertical grids in adjacent segments and they are collinear, then two
parallel flow paths will be formed in the vertical direction. If the vertical lines are not
collinear, then a common node will be used to connect all the adjacent cell components.
Two examples are shown below:

October 2020
Cavities
Specifying Face Types
Procedure
1. To rearrange a radial arm connection:
a. Click the required connection point to highlight it.
b. Drag the point to its new location.
2. To create an axial side arm connection:
• You will notice that the connection lies on a horizontal grid line.
3. Click Next, and continue as described in Specifying Face Types.

You can specify the default and individual face types.
• Fluid Face - these faces are defined by the horizontal and vertical grid lines of the cavity.
• Solid Face - these faces are the sources of the torque that is applied to the fluid. They can
vary from smooth surfaces to complex geometry such as a bolt head.
• Arm Face - these faces are where there is an external connection to the overall network.
They can be solid or fluid depending on the size of the face. They can also contribute to
the rotation of the fluid depending on the orientation of the connecting flow path.

October 2020
Cavities
Figure 16-5. The Specify Default Face Types Form
Procedure
1. To specify the default fluid face type, click the associated dropdown list and select the
required face type:
2. To specify the solid face and arm face types, click the associated dropdown list(s) and
select the required face type.
3. Click Next.
4. Select the required face, for example Face No 11. Click the associated dropdown list and
select the face type:

October 2020
Cavities
As you select the face type, the relevant face changes to the specified color:
Alternatively, you can change the face type as follows:

a. Click the required face type color (for example, Blue = Rotating Disk Smooth). The
cursor changes to a + of the corresponding color.
b. Click the required face to change it.
5. To specify the remaining face types, click the associated dropdown list(s) and select the
required face type as described above.
6. Click Finish.

October 2020
Cavities
Results
• The wizard closes, and the graphic view changes to show the number of cells
comprising the cavity:

October 2020
Cavities
• The Circuit Type Precedence Order dialog box is displayed:
In this dialog box, select the required circuit type and then click OK. When you this the
following actions occur:
o The 2-Arm cell components that make up the cavity are added.
o The internal and external connections are automatically made. There are certain
rules that govern how connections are made.
o The cells and nodes comprising the cavity are loaded into the Component Collection
List.

October 2020
Cavities
Configuring the Cavity Component
The figure below shows a typical cavity.

There are two methods that you can use to configure the cavity component.
Prerequisites
Ensure all cell components and nodes are loaded into a Collection List.
Procedure
1. Choose a cell component to display its properties in the bottom pane.

October 2020
Cavities
2. Set the cell and node data. This involves setting the Y coordinate to the required level.
To look at the arm mapping for the component, open the Cavity Connections tab.
3. Method 1:
a. Click the Show Arm Mapping button. An information message is displayed.
b. Click Yes to save the network.
The arm mapping details are displayed:
In this example, you can see that Cavity Arm No. 1 connects to Component C 53,
Component Arm No. 1, and that Cavity Arm No. 2 connects to Component C 55,
Component Arm No. 2.
Caution
You should only click Yes if you are satisfied with the cavity. You cannot make
any changes to connections, etc once you have saved the network.
a. When you have finished, save the changes and close the Composite Component
window.
With just the network window open, you will see that the cell components and nodes are
also displayed in the Collection List.
4. Method 2:
a. Customize the component by clicking the Edit Physical Parent Component button
to display the Component Customisation Form.
b. You can now choose to look at the arm mapping. To do this, click the Show Arm
Mapping button. An information message is displayed.

October 2020
Cavities
Adjusting the Node Elevations
c. Click Yes to save the network, the arm mapping details are displayed:
From this, you can see that Cavity Arm No. 1 connects to Component C 42,
Component Arm No. 1, and that Cavity Arm No. 2 connects to Component C 44,
Component Arm No. 2.
Caution
Only click Yes if you are satisfied with the cavity. You cannot make any changes
to connections, etc once you have saved the network.

Setting the node elevations within the cavity is critical for the proper calculation of the swirl
effects, since it is dependent on the distance from the axis of rotation. As a cavity can have a
large number of internal nodes, Simcenter Flomaster has a facility that enables the internal node
elevations to be set, based on the elevations of the external connecting nodes. It also performs
an error check to determine if the elevations of the external nodes correctly correspond to the
different elevations of the multiple cavity arms.
Procedure
1. Set the 'Y' values (the distance from the center of rotation for all of the external nodes in
the network).

October 2020
Cavities
The figure below shows an example where external Node 2 is set 0.2 m
2. Right-click on the cavity symbol and choose the Adjust Node Levels.
A confirmation message is displayed.
3. Click Yes to save the changes.
Note
When you run a simulation on the network, Simcenter Flomaster performs a check
to ensure that all the nodes connected to Arms 2 to n have 'Y' values that match the
elevation of Arm 1, plus the vertical distance from Arm 1 to the connecting arm. If any
values are incorrect, then the simulation error halts.

October 2020
Cavities
Viewing the Cavity Results
Viewing the Cavity Results

There are two ways in which you can view results assocaited with cavities.
Viewing the Individual Cell and Face Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Viewing the Individual Cell and Face Results

Cavities have results associated with the individual cells and faces that make up the cavity. You
can view these results in the same way that you view the results of components.
Prerequisites
• A Network containing a cavity.
• A results set.
Procedure
1. In the network Drawing window, double-click on the Cavity Component.
The Cavity View Choice dialog box opens.
2. Select Network and click OK to open the Cavity Component in a new tabbed Network
Drawing window.
From this view you can see the cells and faces that make up the cavity.
3. Select any cell or face to add it to the current collection.
4. Switch the bottom right-hand pane to display Results.
Individual results for the selected cell or face can be viewed.
For more information on viewing and working with results see “Results” on page 417.
Using the Cavity Results Viewer Tool

The Cavity Results Viewer is designed to present you all results relating to a cavity in one place.
• A license which permits cavity creation and simulations.
Prerequisites
• A Network containing a cavity.
• A set of results.

October 2020
Cavities
Procedure
1. From the Network right-click on the Cavity component that you want to view the results
for and select View Results.
The Cavity Results Viewer dialog box opens.
From this dialog box you can view the results of the cells and faces.
2. Use the scroll bars to navigate.
3. For each Cavity you can see the Arm and Node data such as Position, Pressure, and
Swirl. You can also see the Cell data such as Pressure Drop, Total Heat Flow, and
Torque.
4. By clicking on the expand arrow for a Cell you can view its Arm data.
5. You can apply filters to restrict the values presented in the Cavity Results Viewer.
For example you can restrict the Pressure to greater than 8 bar to filter out any pressure
results lower than that value.
a. To add a filter, click on the at the top of any column and choose a filter type.

October 2020
Cavities
b. Type a value in the field.

The filter is automatically applied and the results table is updated.
c. Clear any filters by clicking the button.
6. You can export the results in the Cavity Results Viewer to an Excel Spreadsheet.
a. Click the EXPORT TO EXCEL button.
b. Specify a file name and location.
c. Click Save.
The Excel file is saved to the location you specified.
7. Click CLOSE to close the Cavity Results Viewer.

October 2020
Chapter 17
Modeling Air Conditioning Systems
There are a range of components which you can use when modeling air conditioning systems.
• AC Accumulator
• AC Bend
• AC Boundary
• AC Capillary Tube
• AC Compressor
• AC Condenser
• AC Discrete Loss
• AC Evaporator
• AC Fixed Orifice Tube
• AC Generic
• AC Pipe
• AC Receiver-Drier
• AC Subcool Gauge
• AC Thermal Expansion Valve
• AC Variable Orifice Valve
In addition to the above components, there is a range of Advanced Heat Exchangers that you
can use
You can model air conditioning systems in the following simulation types:
• Incompressible Steady State with Heat Transfer

• Incompressible Transient with Heat Transfer
Note
You must have a license that allows Air Conditioning modeling.

October 2020
The following limitations apply:
• Only one AC loop can be modeled.

• Only one AC compressor is allowed in the loop.
• The compressor or upstream boundary source defines the direction of refrigerant flow in
the AC loop. If any AC component opposes this direction, an error halt is triggered
• A unit test network must have two AC boundary sources, one upstream to start the
network, the other downstream to close the network.
• Non AC Simcenter Flomaster components are not permitted in the refrigerant flow path.

October 2020
• Standard Simcenter Flomaster components may be placed in the air flow paths of the
condenser and evaporator as shown below:
Figure 17-1. Typical AC Circuit with Additional Simcenter Flomaster
Components
Note
Depending on the type of AC circuit being modeled, then the receiver-drier and
accumulator components may or may not be required.
• The refrigerant fluid used in an A/C circuit is specified in the compressor (or each unit
test boundary source).

October 2020
• Every complete AC loop must have the following loop connectivity: (compressor ->
condenser -> expansion device -> evaporator).
• Various circuit designs are possible (evaporators in parallel or series, Condensers in
parallel or series, multiple pipes, as the user's license allows).
• If multiple refrigerant paths are present in the AC loop, they must always start branching
from one node and collapse at one node. Partial collapsing along one of the branches is
not supported.
• Branching is not supported in unit tests.
• The compressor and upstream boundary source are considered the first component in the
AC circuit.
The following notes are applicable to Charge Mass Determination
• With the 'Total Refrigerant Charge Mass' set on the 'Pressure/Mass Criteria' sub-form,
then the simulation acts as normal. The system states are determined by setting the
boundary conditions and by conserving the total refrigerant mass.
• With the 'Condenser Sub-cool' data item SET and with 'Total Refrigerant Charge Mass'
NOTSET, the solver fixes the Condenser sub-cool and then calculates the necessary
operating conditions to satisfy the other parameters of the circuit, such as Heat
Exchanger performance, Compressor performance, and the characteristics of the TXV.
It then computes the mass inventory of the system, to determine the 'Total Refrigerant
Charge Mass'.
For AC transient simulations, the charge mass is determined at the initialization stage
and remains fixed for the remainder of the simulation.
The following notes are applicable to Steady State Convergence Conditions
• Total Charge Mass Set - a good starting point is with the 'Pressure Change per Mass
Error' set to between 0.05 bar/kg and 1.0 bar/kg.
• Charge Mass Determination - a good starting point is with the 'Pressure Change per Sub-
cool Error' set to between 0.0001 bar/k and 0.01 bar/k.

October 2020
Chapter 18
Air Conditioning Shape Factor Optimization
Program (ACSOP)
The Air Conditioning Shape Factor Optimization Program (ACSOP) is an optimization

program that automatically calculates tuning parameters (shape factors) that match the
performance of Evaporators and Condensers, when used in Simcenter Flomaster’s Automotive
AC module.
The following components require shape factor input data to be modeled correctly in an AC
system:
• Evaporators
• Condensers
• AC Coaxial Heat Exchangers
• AC Internal Heat Exchanger
• AC Cross- Flow Heat Exchangers.
Using ACSOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
ACSOP - Worked Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
The ACSOP Optimization Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Using the Boundary Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Using ACSOP
The Air Conditioning Shape Factor Optimization Program (ACSOP) is an optimization
program that automatically calculates tuning parameters (shape factors) that match the
performance of Evaporators and Condensers, when used in Simcenter Flomaster’s Automotive
AC module.
Prerequisites
• An AC Enabled Simcenter Flomaster license.
• An air conditioning network open in the Network Drawing window.
Procedure
1. Select ACSOP... from the Tools menu.
The ACSOP: Condenser Shape Factor Tool dialog box has three tabs.

October 2020
Air Conditioning Shape Factor Optimization Program (ACSOP)
Using ACSOP
• The Optimization form - used to input optimization settings.

• Test Input Data form - used to input the required test data.
• Run ACSOP - used to run ACSOP and view the results, and calculated shape factors.
2. Open the Test Data tab.
The Test Data form is used to input the test data. You can enter up to six sets of data for
each test network.
For test networks containing the following components:
• AC Coaxial Chiller-Heater
• AC Heat Exchanger.
The AC Coaxial Chiller-Heater Shape Factor Tool and AC Internal Heat Exchanger
Shape Factor Tool forms are used. From these you can input:
• Inside Input Data - Mass Flow, Pressure, Quality, and Temperature.
• Inside Output Data - Duty and Pressure Drop.
• Outside Input Data - Volumetric Flow Rate, Pressure, Temperature, and Specific
Humidity.
• Outside Output Data - Temperature Change (Evaporator only) and Pressure Drop.
3. Click the Test Input Data (1 - 6) menu and select the required test no.
4. Select the Include Test Data option.
5. Enter data for each setting by clicking in the required field.
Note
All data slots must be set or ACSOP will error halt.
6. When complete, click the Save As button and use the Save As dialog box to save the file
to a location of your choice.
Note
You can also open previously saved ASCOP files from here.
7. Open the Optimisation tab.

These settings allow you certain control over how ACSOP performs the optimization.
Apart from the Solution Tolerance parameter, you are advised not to change any of the
settings. The Solution Tolerance parameter is used as a terminating condition for the
ACSOP simulation. If the reported percentage error is below this value, for all measures
included in the test, the calculation is complete.

October 2020
Using ACSOP
The values shown on the form have proved to be stable and accurate. They have been
used for a wide variety of tests under different operating conditions.
Note
If you are testing an evaporator set the CondMdot (Condensattion Mass Flowrate)
setting to Off for more realistic results.
8. Open the Run tab.

The Run ACSOP form is used to run ACSOP and to view the results of the optimization
process and the derived shape factors, for the network under test.
Figure 18-1. ACSOP: Internal Heat Exchanger Shape Factor Tool

October 2020
Using ACSOP
The Optimization Results section:

• Current Analysis Count - records the number of Simcenter Flomaster simulations
that ACSOP has performed during the optimization process.
• Current Step Modifier - shows how large a step ACSOP takes in changing the shape
factors. At the start of the simulation, this will be a large value (e.g. 1), but as the
optimization process progresses, the step modifier decreases as ACSOP fine-tunes
the shape factors to their final value.
• Current Error Norm - this is a measure of how large the error ACSOP has calculated,
using its best candidate shape factors, at a particular point in the optimization
process. It is not a percentage error.
The Ascop results section:
As ACSOP searches for the shape factors, percentage errors between
Simcenter Flomaster optimization process and the input test data, are shown in the
Inside and Outside results fields. If all the errors are below the Solution Tolerance, the
optimization is complete and ACSOP will stop the simulation.
The Shape Factor Results section:
This section shows details relating to the calculated shape factors. They represent the
'best fit' that ACSOP could find that matches either the Evaporator or Condenser
performance, to the entered test data.
Often by restarting the simulation, ACSOP can find a 'better' set of shape factors, i.e.
lower percentage errors. This happens because by restarting the optimizer, you reset the
step size to a large value which allows ACSOP to 'step out' of a local minima and in
doing so, it has a chance to locate a smaller minima, i.e. an improved solution.
When ACSOP is started the numbers in the cells under the heading 'Calculated Shape
Factors' are used to as its initial guess at the shape factors. This is helpful as restarts
always use the latest shape factors and so convergence times are much quicker than if
the simulation had started from default (all 1).
The information shown under the heading 'Shape Factor Weighting Parameters' is useful
when you want to get a solution quickly by helping ACSOP to attack the biggest errors.
Assume that you are analyzing over six test points and pressure drop errors are small but
duty errors are high. You can abort the simulation, set a high weighting value on duty,
say 100, and restart the simulation. ACSOP will aggressively attack the duty error to
bring it down to acceptable levels. If this results in other errors growing, than you can
abort the simulation and reset weights to target the high error and then re-run the
simulation. You can repeat this process until you are satisfied with the solution.
Related Topics
ACSOP - Worked Example
The ACSOP Optimization Process

October 2020

This example shows how to build a test network, set the component data and use that to run an
ACSOP simulation.
The steps are:
1. Build a test network and set the component data.

2. Run a simulation on the test network.
3. Input some test data into ACSOP.
4. Run ACSOP and look at the results.
The results obtained are determined the input test data and the test network (shown below).
Figure 18-2. ACSOP: Condenser Test Network
Note
Initially, all the Shape Factors are set to '1'. When you run ACSOP, it will optimize the
shape factors and then automatically load the new values into the Condenser data form.

October 2020

Inlet Port Diameter 0.008 m
Inlet Port Diameter 0.008 m
Refrig. Pipe Hydraulic 0.008 m
Diameter
Refrig. Cross-sectionla Area NOTSET m2
Frontal Area 0.28 m2
Total Refrigerant Volume 0.00105 m3
Shape Factors (Sub Form)
Air Side - HTC 1 W/m2 deg K
Air Side - Pressure Drop 1 bar
Ref Side - HTC 1 W/m2 deg K
Ref Side - Pressure Drop 1 bar

Boundary Location 2. Downstream -
Type (Downstream) 2. Mass Flow Source -
Pressure NOTSET bar
Mass Flow Rate -0.04 kg/s
Temperature NOTSET deg C
Quality NOTSET -
Refrigerant Fluid Type R134a -

Boundary Location 1. Upstream -
Type (Downstream) NOTSET -
Pressure 4.1 bar
Mass Flow Rate NOTSET kg/s
Temperature 12 deg C

October 2020
Table 18-3. Component 3: Required Data (cont.)

Quality 1 -
Refrigerant Fluid Type R134a -

Liquid Type Dry Air as a Real Gas -
Gas Type NOTSET -
Humid Air CAlculation NOTSET -
Visualiser and Segmenter All NOTSET -
Data (SubForm)
Total Pressure 0.97 bar
Static Pressure NOTSET bar
Constant Temperature 43 deg C
Absolute Humidtity NOTSET -

Liquid Type Dry Air as a Real Gas -
Gas Type NOTSET -
Humid Air Calculation NOTSET -
Visualiser and Segmenter All NOTSET -
Data (SubForm)
Vol. Liquid Flow Rate -0.15 m3/s
Volumetric Gas Flow Rate NOTSET kg/s
Constant Temperature NOTSET deg C
Absolute Humidtity NOTSET -
Having built the test network, the next step is to run a simulation and make sure that there are no
errors in the initial input data. See Using ACSOP.
Next access ACSOP and input the test data. Then run ACSOP.
1. Select the ACSOP option from the Tools menu. The ACSOP dialog box is displayed.
2. Click the Test Data Input tab and enter the test data as shown below.

October 2020
Figure 18-3. ACSOP: Condenser Shape Factor Tool
3. Select the Include Test Data option.

4. Click the Save As button to save the file to a location of your choosing.
Run ACSOP and view the results.
1. Click the Run ACSOP tab to display the Run ACSOP form.
2. Click the Run Once button. ACSOP reads the air-side and refrigerant side input data,
populates the data forms for the boundary components, and performs a single
simulation. A confirmation dialog box is displayed when the simulation is complete.

October 2020
Note
You will see some percentage errors reported for the air-side and refrigerant side
because we have not yet performed any optimization calculations on the shape
factors.
Figure 18-4. ACSOP: The Inside and Outside Shape Factors
3. To optimize the results, click the Optimize button.

4. Set 'Solution Tolerance' set to 5%, ACSOP performs a series of 'runs' and calculates the
shape factors shown below:
Figure 18-5. ACSOP: The Inside and Outside Shape Factors
You will notice that the DP (% err) percentage errors for the air-side and refrigerant side
have reduced and the optimization results are displayed.
Note
The results obtained are with CondMdot set to 'Off'.
You can continue the simulation runs by changing the Solution Tolerance and Shape Factor
Weighting Factors settings.
Once you have finished close ACSOP and review the data form for the condenser in the test
network. you will see that the values for the shape factor obtained from the optimization process
have been loaded into the relevant slots.

October 2020
Figure 18-6. ACSOP: The Resulting Property Values
Related Topics
Using ACSOP

The aim of the ACSOP optimization process is achieve a realistic model for evaporator/
condensers. You do this by deducing a set of shape factors so that the results from
Simcenter Flomaster closely match experimental data.
Shape factor data items are available for:
• Evaporator
• Condenser
• AC Coaxial Chiller-Heater
• AC Internal Heat Exchanger
• AC Heat Exchanger.
Method Details
The experimental data required to perform an optimization are:
• Outside Input Data - Volumetric Flow Rate

• Outside Input Data - Inlet Pressure
• Outside Input Data - Inlet Temperature
• Inside Input Data - Refrigerant Mass Flow Rate
• Inside Input Data - Refrigerant Inlet Quality for Evaporator, or Refrigerant Inlet Temp.
for Condenser
• Outside Input Data - Pressure Drop
• Outside Input Data - Temperature Change
• Inside Output Data - Pressure Drop

October 2020
• Inside Output Data - Duty.
Note
Refrigerant Side HTC shape factor is not included in optimization, but you can set it to a
chosen value. The 'error norm' calculated from the four output data items is minimized for
all test points.
Defining the Shape Factors

Simcenter Flomaster defines a 'Candidate Set of Shape Factors' (CSF) as 'Sf', (Sf =
{Air_HTC_sf, Air_DP_sf, Ref_DP_sf, Cond_MDot_sf (evaporator only)}). These shape
factors can be applied to the Simcenter Flomaster test component, and a unit test steady state
simulation conducted for each experimental test point. This exercise will yield a set of
Simcenter Flomaster results that can be compared to the experimental results such that;
Air_DP_Err = (Air_DP_Exp - Air_DP_FM)/Air_DP_Exp
Air_DT_Err = (Air_DT_Exp - Air_DT_FM)/Air_DT_Exp
Ref_DP_Err = (Ref_DP_Exp - Ref_DP_FM)/Ref_DP_Exp
Ref_Duty_Err = (Ref_Duty_Exp - Ref_Duty_FM)/Ref_Duty_Exp
These 'xx_xx_Err' values can be combined to produce a single 'error norm' for the chosen data
point, i, and the shape factors, Sf, such that:
Ei = (Air_DP_Err * Air_DP_Wt)2 +
(Air_DT_Err * Air_DT_Wt)2 +
(Ref_DP_Err * Ref_DP_Wt)2 +
(Ref_Duty_Err * Ref_Duty_Wt)2
where 'xx_xx_Wt' is a user selected weighting factor. The overall 'error norm' for Sf is then
defined as:
ESf = Max(Ei .) for i=1 to N, where N is number of experimental test points.
This reduces the problem to an optimization of 'E= g(Sf)' over the space of possible sets of
shape factors, Sf.
The method of steepest descent is used to find the optimum Sf value. Starting from a given S f
and the associated 'xx_xx_Err' values a set of candidate Sf's are established. An ESfj (j=1 to 3
(condenser) or 4 (evaporator)) is calculated for each of these Sf's using the approach described
above. The 'Sf' that yields the maximum reduction in 'error norm' is adopted as the next

October 2020
'potential Sf' in the optimization sequence, and the process is repeated until no further
improvements in the 'error norm' can be attained, or until one of the other exit conditions are
met. The alternative termination conditions are; (i) that the maximum 'xx_xx_Err' value for all
test points falls below a user defined threshold of acceptability or; (ii) that the number of steps
taken in the optimization sequence exceeds some pre-defined maximum (200 or 300 steps
seems a reasonable value in this case).
The Success of the Optimization Process

The key to the success of the optimization process is how well the candidate set of Sf's are
evaluated. Knowledge of the physical processes at play in the air conditioning components
allows the number of candidates that require assessment to be reduced to a maximum of four at
each step. Even though there is not complete independence between the four different
components of Sf (e.g. modifying the Air_HTC_sf can have an effect on the required value of
Ref_DP_sf to produce the minimal error norm) the approach is to consider steps in each Sf
component separately. This produces a set of candidate Sf's defined as:
CSF = {SfAir_HTC, SfAir_DP, SfRef_DP, SfCond_MDot (evaporator only)}
where the subscript indicates the component shape factor modified to produce that candidate.
SfAir_HTC, SfAir_DP, SfRef_DP, are evaluated as follows: Define:
fzz_zz_sf = (xx_xx_Exp / xx_xx_FM)p
where; p = Step_Size_Controller (a user selectable parameter for tuning the optimization

process, default value = 1.2, range; 1.0<= p <= 2.0) and; there exists a simple mapping between
the shape factor components and the output data items as follows:
[Air_HTC_sf => Ref_Duty_yy, Air_DP_sf => Air_DP_yy, Ref_DP_sf => Ref_DP_yy]
with yy = 'Exp' or 'FM'. Then:
Sfzz_zz(zz_zz_sf) = Sfcurrent (zz_zz_sf )* (1 + (fzz_zz_sf - 1) * m) and
Sfzz_zz(xx_xx_sf) = Sfcurrent (xx_xx_sf ), for xx_xx ¹ zz_zz
where Sfcurrent is the current best estimate of Sf, Sfzz_zz is the new candidate Sf to incorporate
into CSF, Sf(zz_zz_sf) is the zz_zz_sf component of Sf and, xx_xx and zz_zz can take the
values Air_HTC, Air_DP or Ref_DP. This is a simple rearrangement of Sfzz_zz(zz_zz_sf) =
Sfcurrent(zz_zz_sf)*fzz_zz_sf to take account of the need to include parameter m. The
parameter m is steadily decreased during the optimization process from a starting value of 1,
and acts to refine the 'search' for the optimum Sf.
If for a given value of 'm' none of the members of CSF produce a reduction in current 'error
norm' then 'm' is reduced according to the following series:
mj = 1, Step_Size_Modifier, (Step_Size_Modifier)j… where j=0 to D

October 2020
Using the Boundary Components
where D is the Number_Of_Step_Decrements and represents the point at which the changes in
each component of Sf have become so small as to have no effect significant effect on the final
solution. The Number_Of_Step_Decrements is a user selectable parameter, the default value is
10, though values up to 30+
may be required for some network configurations. The Step_Size_Modifier is also a user
selected tuning parameter that controls how quickly the step size sequence decays. The default
value is 0.8 and the range is 0 < Step_Size_Modifier < 1, though values in the range 0.5 to 0.9
have proved to be most productive.
SfCond_MDot is evaluated using the same principle outlined for the other three candidates, but
the principle equation for assessing the candidate is:
SfCond_MDot_(Cond_MDot_sf) = Sfcurrent (Cond_MDot_sf)* (1 + ((1-fCond_MDot_sf)/

fCond_MDot_sf)*m) and
SfCond_MDot(xx_xx_sf) = Sfcurrent (xx_xx_sf ), for xx_xx ¹ Cond_MDot
where: fCond_MDot_sf = (Air_DT_Exp / Air_DT_FM)p. These expressions are a simple

rearrangement of SfCond_MDot(Cond_MDot_sf) = Sfcurrent(Cond_MDot_sf)/
fCond_MDot_sf to take account of the need to include parameter 'm' in the algorithm.
The 'steepest descent' algorithm is not the most efficient optimisation algorithm available.
However in this particular case it is well suited to dealing with the complexities presented in this
problem. These include: (i) the complex nature of the interaction between the different
components of Sf and, (ii) the complex effects of modifying a shape factor have on a simulation.
It is also a robust algorithm that can be easily protected against spurious 'Sf values' which could
cause the simulation to fail. As has been shown above, it is also easy to generate a CSF from the
experimental data and the output from the simulations. For these reasons it is felt that the
'steepest descent' method provides a sound basis for the calculation of shape factors.
Related Topics
Using ACSOP

When acting as a downstream source, the component can specify either Pressure or Mass Flow
(Quality and Temperature are not required). The component checks for Pressure or Mass Flow
and will error-halt if either are not set.When acting as an upstream source you must set Pressure,
Temperature, or Quality to define the correct boundary conditions.
At the start of the simulation, depending on what input data is set, Simcenter Flomaster will
calculate what other data is required based on the fluid properties.

October 2020
Table 18-6 shows the allowable input conditions and the relevant actions that are taken and the
decisions that are taken, depending on the conditions that are encountered when operation as an
Upstream Boundary.
Table 18-6. AC Boundary Input Data Combinations
Condition State 1 2 3 4 5 6 7
1 Boundary Location = Upstream Y N N N N N N
2 Boundary Location = Downstream N Y Y Y Y Y N
3 Type (Downstream) = Pressure Source - Y Y N N N -
4 Type (Downstream) = Mass Flow - N N Y Y N -
Source
5 Pressure or Pressure v Time Curve Set - Y N - - - -
6 Mass Flow Rate or Mass Flow Rate v - - - Y N - -
Time Curve Set
A Use Upstream Boundary Decision Table x
B Set Pressure at Node x
C Set Mass Flow Rate to Node x
D Ignore Quality & Temperature, if set x x
E ERROR: Pressure must be defined for x
Downstream Pressure Source
F Error: Mass Flow Rate must be defined x
for Downstream Pressure Source
G Error: Type must be defined for x
Downstream Boundary
H Error: Mandatory data Not Set. x

October 2020
Chapter 19
Visualiser and Segmenter
The Visualiser is a 3D graphical tool that enables you to view the spatial arrangement of the
components that make up a cooling pack. The Segmenter takes a standard Simcenter Flomaster
network and, when requested by the user, identifies groups of Heat Exchangers, and any other
segmentable components, which are adjoining and in series in the air flow path.
The Visualiser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
The Visualiser Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
Setting the Visualiser Component Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Updating Data From the Visualiser Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
The Segmenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
The Segmenter - An Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
The Segmenter - Defining Split Planes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
The Segmenter - Running a Segmentation Simulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
The Segmenter - Viewing Segmentation Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
The Segmenter - Defining the Coordinate System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570

October 2020
The Visualiser
The Visualiser
The Visualiser is a 3D graphical tool that enables you to view the spatial arrangement of the
components comprising the cooling pack. The cooling pack may include components such as
the grill, stacked heat exchangers (charge air cooler, oil coolers, condenser, radiator, etc.) fans
and losses, with air inlet and outlet boundaries. The Visualiser will not display standard
components included in the air flow path or those connected to the cooling pack, such as parts
of the lubrication circuit, ATF system, AC unit and cooling circuit.
The network below represents a simple cooling pack.
Figure 19-1. Using the Visualiser - Example Network

October 2020
The Visualiser
When displayed in the visualiser:
Figure 19-2. Using the Visualiser
Components such as sources are shown as round objects whereas components such as
Condensers, Heat Exchangers, etc, are shown as square objects. You can set the geometrical
data (its position in 3-D space, its height, width and thickness) for each component. You can
also specify the color and transparency (so that you can easily see behind elements of the
cooling pack) for each component.
The following components can be displayed in the Visualiser Window:

Table 19-1. Visualiser Components
Catalogue Component

October 2020
The Visualiser
Table 19-1. Visualiser Components (cont.)

AC AC Condenser
AC Heat Exchanger
AC Cross-Flow Heat Exchangers
Air Side Fan
Radiation Shutter
Stagnation Pressure Source
Losses Discrete Loss
Heat Exchangers Heat Exchanger: Heater-Cooler
Heat Exchanger: Radiator
Heat Exchanger: Thermal
Heat Exchanger: Cross-Flow
Sources Flow Source
Pressure Source

October 2020
The Visualiser Controls

To access from the Network Drawing window choose a group of components and then choose
Visualise from the right-click menu.
The Visualiser is a 3D graphical tool that you can use the view the spatial arrangement of the
components of a cooling pack.
Objects
The Visualiser has four controls that allow you to manipulate the displayed image.
• Rotx
Rotates the image in the 'X' plane.
• Roty
Rotates the image in the 'y' plane.
• Zoom
Use this control to zoom in on the image and this control to zoom out from the image.
You can also use the slider control to zoom in or out.
• Dolly
Acts in a similar manner to a camera dolly, in that as you rotate the control, you zoom in or
out from the image, from the camera view point.
The use of the mouse buttons are described as follows:
Key/Mouse Button Operation
Combination
Left Mouse Button
Acts like a 'Tracker ball' - When used in conjunction with the
button, it enables you to rotate the objects in the Visualiser window.
CTRL + Left Mouse Used to initiate a 'Roll Action' - Holding down the Ctrl key together
Button with the left mouse button enables you to rotate the objects around the
forward direction.
Shift + Left Mouse Provides up, down, left and right translatory motions - it enables you
Button to move the image up or, down, and left or right.
CTRL + Shift + Left Acts like the 'Dolly' control, it enables you to zoom in or out from the
Mouse Button image, from the camera view point.
Menu Item Function

Viewing Selects the object manipulation or pick mode, it also deselects the
camera or viewer mode.
Decoration When you select this option, all the controls and menu items are
removed from the Visualiser window. To restore them, reselect the
option

October 2020
Full Screen When you select this option, the Visualiser window expands to fill the
screen. To restore the window to normal size, reselect the option.
Headlight When you select this option, the lighting effects are removed and the
image is displayed darker. To restore the lighting effects to normal,
reselect the option.
Functions > Home When you select this option, the view is set to view you defined using
the 'Set Home' option.
Functions > Set Home Resets the Home position to current camera position. If you
manipulate the image and want to return to the selected view, then
click the Home button.
Functions > View All provides an overview of all the objects in the visualiser window.
Functions > Seek Allows you alter the center of rotation for the camera. When clicked
on (and in viewer mode), the cursor changes to the symbol shown on
the button. If you position the cursor over the image and left-click on
it, whatever is underneath the cursor is selected as the new center of
rotation. Once the button is released, the camera either jumps or
animates to its new position.
Draw_Style > As Is Resets the objects to their original state.
Draw_Style > Hidden Renders the objects as wire-frame, but only shows the object front
Line faces.
Draw_Style > No Text Renders the objects without any texture.
ure Selecting this option depends on the objects having a textual surface.
As the Simcenter Flomaster objects do not have textured surfaces,
you will see no discernible changes when you select this option.
Draw_Style > Low res Renders the objects in low resolution
olution
Draw_Style > Wire Fr Renders the objects as wire-frame.
ame
Draw_Style > Points Renders the objects as a series of points.

October 2020
Draw_Style > Boundin Renders the extreme objects as bounding boxes as shown
g Box
below:
Move As Functions
Note: for these functions to operate, you first need to click the button.
Move Same as Still Renders the objects in the 'As Is' (unchanged) mode when you move
them.
Move no Texture Selecting this option depends on the objects having a textual surface.
As the Simcenter Flomaster objects do not have textured surfaces,
you will see no discernible changes when you select this option.
Move Hidden Line Renders the objects as wire-frame, but only shows the object front
faces when you move them.
Move Low Res Renders the objects as low resolution when you move them.
Note: As spherical objects are made up of a series of triangles, these
are the only objects that are affected when you select this option.
Move to Wireframe Renders the objects as wire-frame when you move them.
Move to Points Renders the objects as a series of points when you move them.
Move to Bounding Box Renders the extreme objects as bounding boxes when you move
them.
Buffer Functions
Single Buffer Use this option if you have problems with the 'Double Buffering'
option.
Double Buffer This option provides faster graphics manipulation. If you have
problems, such as a black screen when you first open the Visualiser
window, then you should select the 'Single Buffer' option. If you still
have problems, you should obtain the latest driver for your particular
graphics card.

October 2020
Interactive Buffer If this option has been pre-selected upon opening the Visualiser
window, when you manipulate objects in the window, the double
buffer option is automatically selected.
Preferences > Seek to
point
Preferences > Auto Cli When you turn this option Off, it clips the planes of the objects in the
p Planes Visualiser window.
One useful feature with the option turned off, is that as you rotate the
'Dolly' control to move in or out from the objects, objects disappear or
reappear in order of their placement in the group. If you rotate the
control far enough, you can go right through the objects to see those
at the back or front.
Preferences > Spin An Turns the Spin Animation option Off/On.
nimation
Preferences > Rotation When you select this option, a set of axes is displayed on the image.
Axes Subsequently, when you move the image, you can see the image
rotating about the axes.
You can set the axes so that when you rotate the image, the objects
rotate around the selected object.
Note: The axes displayed always refer to the 'Default
Coordinates'. As such, you should not use this feature with the
Alternative Coordinates.
Preferences > Stereo To use this option, you will need a pair of Stereo spectacles which
plug in to the appropriate socket on your graphics card. When you
select this option, the Stereo Preferences dialog box shown below is
displayed:
• To choose a stereo mode, click the dropdown list and select the
required mode.
• Select the Use Stereo check box.
• To set the 'Zero Parallax Balance' and 'Camera Offset', adjust the
required control.

October 2020
Setting the Visualiser Component Data
Related Topics
Updating Data From the Visualiser Window

Before you can view components in the Visualiser window, you must set the required geometric
and positional data for each component.
Procedure
1. With the Network Drawing window open, right-click in the drawing area and select
Collect option.
2. Select the required component to display its properties in the bottom pane. Click in the
Visualiser and Segmenter Data field to display a button.
The Visualiser and Segmenter Data form is displayed.
Figure 19-3. Setting the Visualisation Component Data
4. Referring to Figure 19-3, for some components, extra data items other than those
discussed above are required to be set. They are:
Table 19-2. Additional Component Data

Component Additional Data Item

October 2020
Table 19-2. Additional Component Data (cont.)

Heat Flow Direction - used to set the flow direction through the
Exchanger: component, depending on its orientation.
Thermal
Heat
Exchanger:
Radiator
AC Condenser
Fan Shroud Arrangement - used to set the type of shroud for the
component, depending on whether or not it is upstream or
downstream of a heat exchanger component.
Related Topics

You can update the data for components displayed in the Visualiser window
Procedure
1. With the Visualiser window open, go to the Visualiser Toolbar and click .
2. Click on the component that you want to update.

October 2020
The borders of the object are shown in red, as shown below:

Figure 19-4. The Component Boarders - The Visualiser Window
The component is highlighted in the Collection List and its properties are displayed in
the bottom pane.
3. Select the data item you want to update and enter the new value.
4. Click the Save button to save the changes.
5. Some of the changes you make will be reflected back into the Visualiser window. For
example, if you make a change to the Visualiser and Segmenter Data, such as changing
the color, the transparency or the dimensions of an object, then you will see the change

October 2020
take place. In the example shown below, the color of the Condenser component was
changed to 'Green':
Figure 19-5. The Component Boarders 2- The Visualiser Window
Related Topics

October 2020
The Segmenter
The Segmenter
The Segmenter takes a standard Simcenter Flomaster network and, when requested by the user,
identifies groups of Heat Exchangers, and any other segmentable components, which are
adjoining and in series in the air flow path. It does this by working through the connectivity file.
If other non-segmentable components have been placed between heat exchangers (or other
segmentable components), then these are ignored and are not displayed in the Visualiser.
Segmentable components that are upstream of this point will be segmented separately from
those downstream of it, and the flow from all the segmented paths upstream are mixed in the
unsegmented component(s).
The Segmenter uses the geometric data to identify a segregated air flow path for each
overlapping and non- overlapping segment of all the segmentable components in each
contiguous group. It then creates the appropriate number of segments within each of these
components, and applies the upstream boundary conditions based on any given inlet distribution
(Velocity and/or Temperature) in a Stagnation Pressure Source.
With regard to the orientation of the hot stream flow in the original components, it creates either
horizontal or vertical hot stream flow paths of consecutive segments in series, and connects
these parallel flow paths to each other at the edges of each segmented component. For example,
if the segmentation produces six segments in a Radiator, in two horizontal rows of three for a
horizontal flow radiator, the Segmenter will connect these as two rows of three in series and will
connect the ends of these rows in parallel as shown below:
Figure 19-6. The Segementer
The main reasons for segmenting are:
1. To allow for the air stream reaching the cooling pack by multiple separate routes, for
example, over and under bumper intakes. In such cases, the proportion of the cooling
pack fed by each air stream is not fixed by simple geometry, and some judgment based
on experience is required to decide the position of the sub- division line. The user should
be permitted to enter one or more vertical and/or horizontal positions where the cooling
pack is to be divided.

October 2020
The Segmenter
2. To model the effects of a known air velocity or temperature distribution at the inlet to
the cooling pack. In this case, it would be necessary to divide the cooling pack into a
number of segments of equal cross-section, each of which will be subject to a different
mean flow rate or temperature.
This is simply an extension of the above requirement, where the user is provided with an
'Automatic' option, which then offers alternatives of setting the number of divisions, or
the size of the divisions, in both the vertical and horizontal directions. This option is
likely to produce a very large number of component segments, with a large number of
parallel air paths.
The following tables shows what components can be segmented and how they behave in a
network:
Table 19-3. The Segmentable Components
Component Segments other Is Segmented Comments
Components? by other
Components?
AC Condenser Yes Yes Geometric or Frontal Area sub-
divided according to segment sizes.
Fan Yes No Segments other components along
edges of shroud.
Radiation Shutter Yes Yes Flow Area sub-divided according to
segment sizes.
Stagnation Yes * Can be viewed in the Visualiser.
Pressure Source *May contain a 'Profile Factor'
surface that allows a 'map' of
Pressure Coefficient, Velocity or
Total Pressure to be specified. This
map may be derived from a CFD
simulation or from testing. A
Temperature Ratio surface may be
used separately or in conjunction
with the Profile Factor.
Discrete Loss Yes Yes If this is included to allow for
obstructions adjoining, or within the
cooling pack, then the Flow Area
should be sub-divided according to
the segment sizes.

October 2020
The Segmenter
Table 19-3. The Segmentable Components (cont.)

Heat Exchanger: Yes Yes Geometric or Frontal Area sub-
Radiator and divided according to segment sizes.
Heat Exchanger:
Thermal
AC Heat Yes Yes
Exchange, AC
Cross-Flow and
eat Exchanger:
Cross-Flow
Heater-Cooler Yes Yes
Controllers and gauges can be used in segmented simulations. The components can receive
information via a multidimensional array, or via a script. The array is a 2D array comprising 6 x
n values as shown below:
Table 19-4. 2D Array Values
Column No. Value
0 Segment Number
1 Left coordinate of segement
2 Top coordinate of segement
3 Right coordinate of segement
4 Bottom coordinate of segement
5 Signal value for the specified segment
The following points should be noted:
1. If a controller or gauge receives a signal in the form of a multidimensional array, then

the Minimum and Maximum clipping values set in the controller or gauge, will be
applicable to the signal values of each segment.
2. If a controller or gauge receives a signal in the form of a multidimensional array, and in
a script, then the input is checked via the 'InputValue' function and the average value of
the signal for all the segments, is returned as the signal value.
3. If a gauge is connected to the branch of a segmented component, then the signal value
returned will be the average value of the branch values, for the specified feature for all
segments.
4. If the gauges' MI connection is connected to a 'non-segmentable' components' MO
connection, then a single signal value will be returned as the output.

October 2020
The Segmenter - An Example

This example demonstrates how Simcenter Flomaster segments a simple network.
The example network contains a Condenser, Radiator, and Oil Cooler (for an idealized vehicle).
For simplicity, the network fan, shroud or any losses.
The flow in the Condenser is horizontal, vertical in the Oil Cooler and horizontal in the
Radiator. Figure 19-7, shows a diagrammatical view of the network while Figure 19-8 shows
the network itself.
Note
The views shown in Figure 19-7are similar to how objects (without the text) are displayed in
the Visualiser, which enables you to see the front, side, rear and top view of the displayed
objects.
Figure 19-7. The Segementer Model - A Diagramatical View of Test Network

October 2020
Figure 19-8. The Segementer Model - The Test Network
The Segmenter takes the network and automatically creates multiple paths with connectivity
which is equivalent to the network shown below:
Figure 19-9. The Segementer Model - The Segmented Network
Note
The above view shows how Simcenter Flomaster takes the network shown in Figure 19-8
and splits it into multiple components and paths. This view is NOT visible in the Network
Drawing window.
In the above view, the outlet connections from the Radiator have been omitted for clarity.

October 2020
Defining the Segmentation Data for the Example

With reference to the example shown in Figure 19-8, the Segmenter uses the geometric data to
determine the 'fully resolved airflow paths' - air paths in which all the air passes through the
same combination of segmentable components. The algorithm used seeks to minimize the total
number of air flow paths used, while correctly differentiating all parts of the heat exchangers
that are subject to different air or hot fluid conditions.
The figure below shows a diagrammatical view of how the Segmenter takes the example
network and splits it up. The actual segmentation process depends on the flow orientation in all
the heat exchangers.
Figure 19-10. The Segementer Model - Orientation of Heat Exchangers
In the above example, Segments 3 and 4 would be combined if the Oil Cooler flow were
horizontal. If the Condenser flow were vertical, Segment 12 would be split vertically, or if the
Radiator flow were vertical, the segmentation would be completely different. It is important to
optimise the segmentation, rather than using a crude approach, to limit the number of segments.
About Segmentation Groups

In modern vehicles there are often a number of air intake grills to cope with all the underhood
cooling. When using Simcenter Flomaster to model the air flow through these grills, each group
of components used to model the air flow can be defined as a 'Segmentation Group'. You can
define up to 10 groups.

October 2020
The following figure shows an example where two Segmentation Groups are used to model the
air flow through the upper and lower grills:
Figure 19-11. The Segementer Model - Segmenter Groups
Display Segments
The 'Display Segments' option enables you to display the segments for each object shown in the
Visualiser window.
To access the option:
1. Select the Display Segment option from the Tools menu.

October 2020
The Segmenter - Defining Split Planes
2. Right-click in the Visualiser window and select Draw Style and then the Hidden Line
option.
3. Use the Roty control to rotate the objects so that you can see the segments.
Hide Segments
The Hide Segments option enables you to hide the segments for each object shown in the
Visualiser window. To access the option:
1. With the Visualiser window active, go to the Tools menu and choose the Hide
Segments option.

You can split individual or groups of components in a cooling pack. This allows you to define
the number of vertical and horizontal portions of the component(s).
Prerequisites
• Ensure that Network Control or Network Drawing window is active.
Procedure
1. Tools > Visualiser and Segmenter > Define Split Planes.
The Define Split Planes dialog box is displayed.

October 2020
Figure 19-12. The Segementer Model - Define Split Panes
The dialog box is divided into two sections:

• Vertical Planes
• Horizontal Planes.
Each section enables you to define the relevant Vertical and Horizontal Splits and the
spacing for selected Segmentation Groups. The Extents sections by default show the
maximum width and height values of the segmentable group. In effect they define a
'bounding box' around the group of components. You can also set the extents for an
individual component in order to obtain an even split in that component. You can do this

October 2020
by going to the Fit Extents to Component dropdown list and selecting the required
component. The following figure shows the results when the 'All' option is selected:
Figure 19-13. The Segementer Model - Example 1
Figure 19-14. The Segementer Model - Example 2
2. To define the value splits:

a. Select the required segmentation group from the Segmentation Group No
dropdown list menu.

October 2020
Note
To see what components are associated with the selected group, click the
Members button.
3. To Fit Extents to a single component select the component from the Fit Extents to
Component dropdown list.
4. To input the Splits for the Vertical and Horizontal Planes, click in the associated
Number of Splits fields and enter a value between 1 and 20, or enter a suitable Split
Spacing.
5. Click the corresponding Generate buttons. The generated values are automatically
inserted into the relevant cells.
6. To enter Vertical and Horizontal Spacing values, click the relevant fields and enter the
required values. Click the Generate buttons.
These values define the split to an absolute position in the relevant plane.
7. To sort the values, click the required Sort button.
8. To save the values for a subsequent segmentation simulation, click the Save button.
9. Use the Display Split Planes option to see how the split planes are overlayed, for each
object displayed in the Visualiser window:
a. Select Overlay Split Planes from the Tools > Visualiser and Segmenter menu.
The Visualiser window opens.
b. Right-click in the Visualiser window and choose the Draw Style option followed by
Hidden Line.

October 2020
The Segmenter - Running a Segmentation Simulation
c. Click the button to see the front of the objects as shown below:
Figure 19-15. The Segementer Model - The Components Dialog Box
The Segmenter - Running a Segmentation

Simulation
Segmentation Simulation determines which components to segment and groups them according
to connectivity and component types, generates any additional components and connecting
nodes for each segment, maps component data to segments, simulates the enlarged network, and
stores the results.

October 2020
The Segmenter - Viewing Segmentation Results
Note
Results for each segment are stored in their parent component. The results can viewed as a
3D surface plot, or in the Visualiser window
Procedure
1. With the Network window active, click the Simulation Data tab.
2. Set the simulation type to: Heat Transfer Steady State.
3. Click in Segment Simulation Enabled cell and choose the Yes option.
4. Click the Configure button to set-up Dynamic Colouration.
5. Click Run.
The simulation starts.
Related Topics

You can visually display the segmentation results.

October 2020
The results discussed in this section are based on the example network shown below:
Figure 19-16. Viewing Segementation Results - Example Network
Prerequisites
• You must collect the components before viewing the results
Procedure
1. Select the required component from the Collection List, in this case the Heat Exchanger:
Radiator component.
2. Click in the cell next to: Segment Numbers to display four buttons.

October 2020
The plot is displayed as shown below:

Figure 19-17. Viewing Segementation Results - Results Plot
The graph shows a plot of 'Segment Number' v 'X' and 'Z' Segment Position, and it
shows a total of 14 segments. In this view, the dark blue segment at the bottom
represents Segment 1, while the dark red color at the top represents Segment 14.
You can view the graph 'as is', but the best view, is to view the graph as a 'Contour'
graph where each segment is colored according to its position. To do this:
4. Right-click in the plot window and choose the Surface option followed by Solid with
Contour.

October 2020
5. Using the mouse, draw a box around the Radiator. Right-click and select Visualise to
display the Visualiser window.
6. Click in the cell next to Segment Numbers to display four buttons.
7. Click the button to display the Colour / Range Band Selection dialog box. For this
exercise, we will be using the Interpolated option with the settings as shown below.
Figure 19-18. Viewing Segementation Results - The Colour / Range Band
Selection Dialog Box
8. Once you have set the required values and colors, click the Continue button.
The Visualiser window is displayed.

October 2020
Figure 19-19. Viewing Segementation Results - The Visualiser Window
In this view, the segments are read from left-to-right and from bottom-to-top. The colors
are defined as:
Table 19-5. Viewing Segmentation Results - Colour Segments for Worked

Example
Colour Segment Position
Dark Blue Segment 1
Cyan Segment 5
Green Segment 6
Yellow Segment 10
Dark Orange Segment 13
Red Segment 14

October 2020
The Segmenter - Defining the Coordinate System
The other segments are colored according to their position.

Related Topics
The Segmenter - Running a Segmentation Simulation

You can define the coordinate system when using the Visualiser and Segmenter
The two systems available are:
• Default Coordinates
• Alternative Coordinates.
Depending on the coordinate system used, it enables you to specify the center position of the
component, plus its width, thickness and height in 3-D space as shown below. Diagrammatic
views of the two systems are shown below:
Procedure
Specify the coordinate system by selecting Visualiser and Segmenter from the Tools menu.

October 2020
Figure 19-20. Defining the Coordinate System

October 2020

October 2020
Chapter 20
Modeling Vehicle Systems in 3D
Simcenter Flomaster contains tools to help you model vehicle systems when the vehicle is
rotated in 3D space and subject to accelerations other than gravity.
Conventional 1D fluid flow simulation assumes that the fluid circuits have a fixed topography
and are subject to a constant external body force due to gravity. This is not true of mobile
systems, particularly those in aircraft. All mobile systems may be subject to additional external
body forces due to the accelerations experienced by the vehicle; those in aircraft, submersibles
or submarines also rotate in three dimensions.
Modeling Body Forces in 3D Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574

The 3D Coordinate System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Modeling the Vehicle Position using Aircraft Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Modeling Pitch, Roll, and Yaw, Dynamically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581

October 2020
Modeling Body Forces in 3D Space
Modeling Body Forces in 3D Space

The spatial position of a network is determined by the X, Y, and Z coordinates of the nodes
within that network.
Before simulation, you can specify the coordinates of each individual node so that the system
understands its relationship to every other node but, for even the simplest networks, this can be
a lengthy process and does not lend itself to running multiple simulations to test out the effects
of various spatial positions.
Instead you can:
• Specify the Aircraft Data on the Simulation Data tab.

This enables you to set any steady state operating condition of the vehicle in a
continuous (straight or constant radius) flight path. The Aircraft Data parameters will
take precedence over any individual node coordinates. See “Modeling the Vehicle
Position using Aircraft Data” on page 577
The Steady State orientation of the vehicle is modeled. For circular movements, the
acceleration forces on the whole vehicle are taken into account. The orientation,
acceleration and gravity forces are used to calculate the forces acting on the fluids in the
system.
Note
With this method, opposing body forces within the vehicle and its fluid systems that
result from rapid rotation of the vehicle about its own axes are not modeled. The
forces modeled by Simcenter Flomaster act in the same direction on all components in
the network.
• For more complex flight paths you can use one of the Simcenter Flomaster Scenario
Components to specify Pitch, Roll, Yaw, and acceleration against time and use this in
transient simulations to investigate the effect of these forces on network performance.
See “Modeling Pitch, Roll, and Yaw, Dynamically” on page 581
Note
The definition of the X, Y, and Z Coordinates (and consequently the definition of roll, pitch,
and yaw angles) is fixed - You must adapt your inputs to that format.
The Sequence of rotation is fixed; first yaw, then pitch, then roll.
The 3D Coordinate System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575

October 2020
The 3D Coordinate System

The Node 3D Coordinate data enables you to specify the positions of the components in the
Simcenter Flomaster fluid circuits that are subject to body forces as the vehicle moves. These
positions can be expressed in the same familiar coordinates as the main coordinate system that
is used for the airframe itself.
The right-hand rule is used in defining the Simcenter Flomaster 3D Coordinate system, which
has a fixed orientation relative to the vehicle, but an arbitrary origin. The X axis must be parallel
to the longitudinal axis of the vehicle (usually the body/fuselage axis). Since the Z axis is
conventionally vertical (up or down) the Y axis must be the horizontal transverse axis.
In most cases, the components of the fuselage are numbered sequentially from nose to tail, so
we chose the X axis positive direction to point aft. It is conceptually much easier to define such
things as liquid level in tanks, if the Vertical axis is positive upwards, so we chose the Z axis
positive direction to point up. The right hand rule then dictates that Y axis values should
increase to the right (starboard) side of the vehicle (that is to the left when viewed in the positive
direction of the X axis.
The origin of these axes may be placed anywhere in relation to the vehicle, including at the
centre of gravitry or rotation. Normally, you would choose the origin to correspond with that of
the principal coordinates for the vehicle. For example, you may place the origin some distance
ahead of the nose, on the transverse axis of symmetry and at the mid-height of the fuselage.
Once the origin of coordinates is chosen, the position of the components can be defined in a
fixed relationship to the airframe. This is done by setting the X, Y and Z coordinate of each
Node and the level information in such components as Accumulators and Reservoirs. These
positions then remain fixed relative to the vehicle during simulations, so that all components
defined in this way move with the rotation of the vehicle and are subject to the same
accelerations as the whole vehicle.
The effect of Altitude on outside/boundary Temperature & Pressure is defined in the Ambient
Conditions Sub-Form, while the Attitude and Accelerations of the vehicle are defined in the
Aircraft Data Sub-Form. Both of these Sub-Forms are found on the Simulation Data tab of the
Network window.
Circuits that are not much affected by hydrostatic effects due to rotation and acceleration of the
vehicle need not be defined in 3D coordinates. Such systems might include those that operate at
high pressure, such as control or landing gear hydraulics or those containing low-density fluids,
such as air systems.

October 2020
Parameter Definitions
Figure 20-1. The 3D Coordinate System in Vehicle Simulations
• X Coordinate, xn
• Distance of Node n aft of the arbitrary origin of the coordinate system.

Default = NOTSET
• Y Coordinate, yn
Distance of Node n towards the right (starboard) side of the vehicle from the arbitrary
origin of the coordinate system.
Default = NOTSET
• Z Coordinate, zn
Distance of Node n above the arbitrary origin of the coordinate system.

Default = NOTSET
Simulation Description
The Node coordinates enable the position and orientation of the components between them to be
calculated. One-armed components, such as Accumulators and Reservoirs have independent
data for elevation, but their X,Y position is assumed to coincide with that of the connecting
node. They therefore maintain a fixed position in all three dimensions as the vehicle rotates, and
the hydrostatic pressure difference between them varies accordingly.

October 2020
Modeling the Vehicle Position using Aircraft Data
When the user, directly or indirectly (see “Modeling the Vehicle Position using Aircraft Data”
on page 577) defines the Attitude (Roll, Pitch & Yaw) and Accelerations of the vehicle, the
following occur:
• The elevations and orientations are adjusted for all components that are connected to
Nodes where the 3D Coordinates are non-zero.
• The resultant acceleration is used to calculate the component of body force acting along
the axis of the relevant components.
• The axial component of body force is used in calculating the pressures and mass flow
rates in the network.
For most loss components, the axial component of body force is modelled in steady state
and transient flow by taking in to account the body force component in the quasi-steady
momentum or pressure drop equation.
For detailed information on how the component of body force is used in pressure and
mass flow rate calculations in different pipe models, see the section on Pipes in the
Simcenter Flomaster Component Simulation Description Manual.
Modeling the Vehicle Position using Aircraft

Data
The Aircraft Data Sub-Form allows you to specify simple flight path properties (such as ground
speed), describe the attitude of the vehicle, or to set directly the component accelerations of the
vehicle as a body. This enables you to set any steady operating condition of the vehicle in a
continuous flight path of your choice.
A straight flight path, or one of constant radius, can be defined as:
Table 20-1. Aircraft Data - Specifying Flight Conditions
Flight Condition Data Settings
Straight Path 1. Ground Speed set to an appropriate value
2. Turn Radius = Not Set
3. Inclinometer Reading = Not Set or 0
Coordinated Horizontal Turn 1. Ground Speed = actual ground speed
2. Turn Radius = actual turn radius
3. Inclinometer Reading = 0
Horizontal Turn with 1. Ground Speed = actual ground speed
Sideslip 2. Turn Radius = actual turn radius
3. Inclinometer Reading = angle appropriate to sideslip.

October 2020
In the above cases, the component accelerations are not required and should be Not Set. For
more complex flight paths, you may set all three component accelerations (Longitudinal,
Transverse and Normal) while leaving Ground Speed, Turn Radius and Inclinometer Reading
Not Set.
In all cases, the values of Roll, Pitch and Yaw need to be set if they are non-zero. (Not Set
properties will be assumed to be zero). These properties are defined with respect to the Centre
of Rotation. This is defined in terms of the vehicle 3D Coordinates, in which the position of the
fluid circuits was described.
Aircraft Data - Parameter Definitions

• Ground Speed, V
This is the constant value of the absolute velocity of the vehicle used to calculate the
centripetal transverse acceleration, if the Turn Radius is also set. If Ground Speed is
NOTSET, a value of zero is assumed.
Default = NOTSET
• Turn Radius, R
This is the constant value of the radius of the track of the vehicle over the ground. It is
used to calculate the centripetal transverse acceleration, if the Ground Speed is non-zero.
If Turn Radius is NOTSET, a value of zero is assumed.
Default = NOTSET
• Inclinometer Reading
This is a numerical value that represents the reading of the vehicle inclinometer or slip
gauge. If it is set to zero, the program calculates the correct Roll Angle to perform a
coordinated turn, when the Ground Speed and Turn Radius are also set. For turns with
side slip, it enables the program to calculate the Roll Angle that gives the required
Inclinometer Reading for a given Ground Speed and Turn Radius. If it is NOTSET, the
program reads the value of Roll directly from the Sub-Form.
Default = NOTSET
• Position of Centre of Rotation - Sub-Form

October 2020
A sub-form used to define the Position of Centre of Rotation in the 3D Coordinate

system that is use to define the construction of the Simcenter Flomaster circuits:
Figure 20-2. Defining the Centre of Rotation
o X Coordinate, x0
Distance of the Centre of Rotation aft of the arbitrary origin of the coordinate
system.
Default = NOTSET
o Y Coordinate, y0
Distance of the Centre of Rotation towards the right (starboard) side of the vehicle
from the arbitrary origin of the coordinate system.
Default = NOTSET
o Z Coordinate, z0
Distance of the Centre of Rotation above the arbitrary origin of the coordinate
system.
Default = NOTSET

October 2020
Having set the coordinates, the vehicle is then rotated about the displaced axes
through the Centre of Rotation, as shown below:
Figure 20-3. Movement about the Centre of Rotation
• Roll, α
This is the constant angle of rotation of the vehicle about its longitudinal axis through
the Centre of Rotation in a clockwise direction looking aft. If it is NOTSET, a value of
zero is assumed.
Default = NOTSET
• Pitch, β
This is the constant angle of rotation of the vehicle about its transverse horizontal axis
through the Centre of Rotation in a clockwise direction looking to the right (starboard);
i.e. Nose up and tail down. If it is NOTSET, a value of zero is assumed.
Default = NOTSET
• Yaw, γ
This is the constant angle of rotation of the vehicle about the vertical axis through the
Centre of Rotation in a clockwise direction looking upwards; i.e. Nose to the left (port)
and tail to the right (starboard). If it is NOTSET, a value of zero is assumed.
Default = NOTSET
• Longitudinal Acceleration, ax
This is the constant acceleration of the vehicle (or other vehicle) aligned with its
longitudinal axis. A positive value creates a body force on the fluid acting towards the
rear of the vehicle. If it is NOTSET, a value of zero is assumed.
Default = NOTSET

October 2020
Modeling Pitch, Roll, and Yaw, Dynamically
• Transverse Acceleration, ay
This is the constant acceleration of the aircraft (or other vehicle) aligned with its
transverse horizontal axis. A positive value creates a body force on the fluid acting
towards the right (starboard) of the vehicle. If it is NOTSET, a value of zero is assumed.
Default = NOTSET
• Normal Acceleration, az
This is the constant acceleration of the vehicle aligned with its vertical axis. A positive
value creates a body force on the fluid acting upwards. If it is NOTSET, a value of zero
is assumed.
Default = NOTSET
Aircraft Data - Simulation Description

If the Ground Speed and Turn Radius are set, they are used to calculate the centripetal
acceleration and the resultant acceleration in a plane normal to the direction of motion. The
Inclinometer Reading is used to calculate the Roll Angle, using the angle of the resultant. If
Inclinometer Reading is NOTSET, then the Roll is read directly.
The Roll angle, together with Pitch and Yaw are used to calculate the displaced positions of all
the components whose nodes have non-zero 3D coordinates. The Transverse Acceleration, if
not already defined by Ground Speed and Turn Radius, is read together with the Transverse and
Normal Accelerations. These are then used to calculate the axial component acceleration in the
relevant displaced components, so that the correct pressures and flow rates can be computed.

You can model node elevation changes, such as that experienced by an aircraft rolling or a
submarine diving, over time in transient simulations. You can use this feature to, for example,
investigate how fuel flows from one reservoir to another during these types of maneuvers.
Prerequisites
• A Simcenter Flomaster network that describes the fluid pathways that you want to
model.
Procedure
1. Specify the node position for each node by selecting each node and then entering a value
for the X, Y, and Z coordinates in the Hydraulic Node Properties form.
2. In the Catalogues pane navigate to the Scenario Components and then add either the
Aircraft or Submarine component into the Drawing window.
You do not connect the Scenario Components to any other components in your network.

October 2020
Once added to the Network drawing window the Scenario Component’s properties will
take precedence over any such data that is specified in theSimulation Data tab.
Any curves will take precedence over fixed values.
If all curves are left blank the system is considered to be stationary throughout the
simulation.
Note
For both fixed and dynamic position simulations the Position of Centre of Rotation
parameters (mandatory) define the reference point about which the vehicle moves.
3. To model a fixed position (fixed Pitch, Roll, and Yaw) throughout the simulation:
a. Specify, in the Scenario Component’s properties table, appropriate values for the X,
Y, and Z Coordinate Position data items.
b. Run the simulation.
The vehicle position is applied by Simcenter Flomaster prior to simulation and held
in that position for the duration of the simulation.
4. To model changes in position (dynamic Pitch, Roll, and Yaw) throughout the
simulation:
a. Specify, in the scenario Component’s properties table, appropriate values for the
Roll, Pitch, Yaw, Longitudinal Acceleration, Transverse Acceleration, and Normal
Acceleration v Time data items to set a flight/dive profile of the system of the system
over time.
b. Run the simulation.
The vehicle position will is applied by Simcenter Flomaster prior to simulation and
held in that position for the duration of the simulation.

October 2020
Chapter 21
Flashing and Two Phase Systems
You can model two-phase systems. Some components can be used to model flashing.
Flashing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Two Phase Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Flashing
Flashing is a phenomenon that occurs when high pressure hot liquid has a rapid pressure drop.
When this occurs, part of the liquid is converted to vapour and a resulting mixture of vapour and
liquid occurs.
The following components model flashing.
Table 21-1. Components that can be used to Model Flashing
Component Family Component Type
Diaphragms • Diaphragm: Bursting Disk
Orifices • Orifice: Long
• Orifice: Long: Pall 8700 Filter
• Orifice: Radiussed
• Orifice: Sharp-Edged (Conical)
• Orifice: Sharp-Edged (Standard Orifice Plate)
• Orifice: Fixed Throttle (60 L/min at 50 bar)
• Orifice: Square
Transitions • All Transitions
Check Valves and • Valve: Clapper Check
Relief Valves • Valve: Gas Admission/Release
• Valve: Pilot Check (180 L/min at 50 bar)
• Valve: Plug Check (after J. Kubie CEGB)
• Valve: Poppet Check
• Valve: Poppet Relief
• Valve: Simple Check (80 L/min at 6 bar)
• Valve: Simple Relief (Crack 240 bar; Maximum 260 bar)
• Valve: Spring-operated Check (D1b125 5.0N Crack)
• Valve: Swing Check

October 2020
Two Phase Flow
Table 21-1. Components that can be used to Model Flashing (cont.)

Control Valves • Orifice Short: Pressure Relief Valve (100 L/min Rated Flow)
• Orifice Short: Variable Throttle (90 L/min at 120 bar)
• Valve: "Y"Valve: Angle
• Valve: Ball
• Valve: Butterfly (Blakeborough)
• Valve: Butterfly (Type A)
• Valve: Butterfly (Type B)
• Valve: Butterfly (Type C)
• Valve: Diaphragm (Full Bore)
• Valve: Diaphragm (Reduced Bore)
• Valve: Gate (Seat Area = Pipe Area)
• Valve: Globe
• Valve: Sluice (Seat Area = Pipe Area)
Two Phase Flow

There are a range of components designed to help you to model two-phase flow in Two Phase
Steady State, Transient, and Restart simulations.
Note
When connecting the components, the circuit type must be set to Complex Two Phase.
Table 21-2. Two Phase Components

Bends • All Bends
Junctions • All Junctions
Heat Exchangers • CW Condenser
• All power Generation (AREVA) Heat Exchangers
Miscellaneous • Generic Component
Orifices • Orifice: Long: Data-based
• Orifice: Long: Geometric
• Orifice: Radiussed
• Orifice: Sharp-Edged
• Orifice: Fixed Throttle(60 L/min at 50 bar)
• Orifice: Square
• Orifice: Variable Throttle

October 2020
Two Phase Flow
Table 21-2. Two Phase Components (cont.)

Pumps Rotodynamic Pump
Sources All Sources
Transitions All Transitions
Check Valves and • Valve: Clapper Check
Relief Valves • Valve: Gas Admission/Release
• Valve: Pilot Check (180 L/min at 50 bar)
• Valve: Plug Check (after J. Kubie CEGB)
• Valve: Poppet Check
• Valve: Poppet Relief
• Valve: Simple Check (80 L/min at 6 bar)
• Valve: Simple Relief (Crack 240 bar; Maximum 260 bar)
• Valve: Swing Check
Control Valves • Orifice Short: Variable Throttle (90 L/min at 120 bar)
• Valve: Valve: "Y"
• Valve: Angle
• Valve: Ball
• Valve: Sluice (Seat Area = Pipe Area)
Note
Enthalpy results for two-phase branch arms is total enthalpy.

October 2020
Two Phase Flow

October 2020
Chapter 22
Component Interaction
The Simcenter Flomaster Component Interaction module, has been specifically designed to
account for the changes that occur to component loss coefficients when other components are
positioned in close proximity.
The program searches for groups of potentially interacting components whose interaction
coefficients depend only on the geometrical configuration of the component and flow direction.
Having calculated all the interaction coefficients for the relevant components, the program
proceeds with a normal Steady State simulation.
Note
You can only use component interaction with Incompressible Steady State simulations.
The loss coefficient quoted for an individual component assumes that it is isolated from the
effects of other components both upstream and downstream. This implies that there is an
upstream length of straight, uniform cross-section pipe which is long enough to ensure that any
flow disturbances produced by an upstream component have decayed before reaching the
component's inlet. It also implies that there is sufficient downstream length of straight uniform
pipe for flow disturbances produced by the component to decay to that of normal pipe flow.
In practice many components are installed in systems with insufficient interconnecting lengths
of pipe for the above assumptions to be valid. In such cases 'interaction effects' occur; for
example, the flow patterns at the outlet of one component may interfere with the flow pattern of
the given component and so its loss coefficient differs from the isolated case.
In general, the loss coefficient of two closely spaced components will not be the arithmetic sum
of the two individual loss coefficients because of the three different types of interaction:
• Type A - Part of the loss associated with redevelopment of the flow after the first
component does not occur.
• Type B - The first component affects the inlet flow conditions to the second.
• Type C - The static pressure distributions may interact directly so modifying the flow
patterns in both components.
Simcenter Flomaster takes account of the interaction effect by either:
• By calculating an Interaction Coefficient, Ic, which is used to modify the loss

coefficient, K, of a component such that:
Keff = KxIc

October 2020
Where:
K = The non-dimensional loss coefficient Keff = The modified loss coefficient that
accounts for the interaction effect
• By modifying a fundamental parameter associated with the component and then using a
standard equation or graph to calculate the loss coefficient.
For example, to model interaction effects in certain types of transitions, Simcenter Flomaster
modifies the length/diameter ratio and then uses a standard curve to obtain the loss coefficient.
Details of the interaction coefficients which are used for different combinations of components
is given in the relevant component sections. In addition, Appendix B contains two tables that
show precisely which type of interaction is applied to the upstream and downstream component
in any interacting pair.
Table 22-1. Component Interaction - Interactive Components
Component Application Area Notes
Bends Incompressible (Hydraulic and Non-
hydraulic Power Applications)
Transitions
Orifices
Junctions
Pumps Incompressible Includes:
• Displacement Pumps
• Rotodynamic Pumps
Valves Incompressible Includes:
• Control Valves
• Check Valves
• Relief Valves
DCVs Incompressible (Hydraulic Power
Applications)
Reservoirs Incompressible (Hydraulic and Non-
hydraulic Power Applications)
Accumulators
Weirs
Table 22-2. Component Interaction - Non-Interactive Components

Pipes Incompressible

October 2020
Component Interaction Types
Table 22-2. Component Interaction - Non-Interactive Components (cont.)

Losses Incompressible (Hydraulic Power Includes Curve Based
Applications) Orifices
Motors
Cylinders
Loads
Valve Dynamics
DCVs Incompressible (Hydraulic Power)
Sources Incompressible (Hydraulic and Non-
hydraulic Power)
Diaphragms Incompressible (Hydraulic Power)
Discrete Losses
Heat Exchangers Incompressible (Hydraulic and Non-
hydraulic Power)
Note
Controllers and Solids cannot be used in Component Interaction Simulations.
Component Interaction Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589

Component Interaction Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
Running a Component Interaction Simulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Component Interaction Types

Type A, B, and C Component Interaction Types are described here.
Note
The information used to describe the 'A' and 'B' type interaction effects is derived from
published data and experimental data undertaken at BHRA. It is presented in 'Internal Flow
Systems' by D.S. Miller, published by BHRA in 1978.
Type A Interactions
Type 'A' interactions are typified by an insufficient length of pipe downstream of a bend. It is
necessary to have a length of as much as 30 pipe diameters in some cases to avoid component
interaction. To a lesser extent, such effects occur for diffusers and orifices when the outlet pipe
length is less than 5 pipe diameters.

October 2020
Component Interaction Usage
In these cases, the loss coefficient is less than would occur with sufficient length of outlet pipe
because part of the loss attributable to the component is associated with flow re-development in
the outlet pipe. If the pipe is too short, part of this loss does not occur. Thus the multiplier used
for A-type interactions is LESS than unity.
Type B Interactions
Bend-bend, bend-diffuser and bend-tee are typical of B-type interactions and are discussed in
detail later. There is good published data covering the more common combinations and the
correction factors are applied either as a multiplier to both components, or in the case of tees, as
an additive correction.
Usually, the corrected coefficients are LESS than the sum of the individual component
coefficients. The B-type correction is applied to cater for the known sensitivity of gradual
diffusers to disturbed inlet flow patterns.
Type C Interactions
This type of interaction is modeled in Simcenter Flomaster for some component combinations
where there is published data. This type of interaction occurs when the spacer, or length of
straight pipe between two components, is less than one pipe diameter.
In such cases the static pressure distribution across the outlet plane of the upstream component
is non-uniform and has not decayed to a uniform profile at the position of the inlet plane of the
downstream component. The outlet static pressure distribution for even the most severe
component will be uniform by about one pipe diameter downstream of the outlet. Thus this type
of interaction, which can produce an overall loss GREATER than the sum of the two individual
components' loss, does not arise if there is always a spacer pipe of at least one diameter in
length.
In practice, if a system includes two components in close proximity, it is very likely that there
will be other components in the system which interact as well. The procedures in
Simcenter Flomaster have been designed to allow for multiple interactions in a systematic
manner which is physically reasonable but which does not exaggerate interaction effects. There
is no published data on multiple interactions.

General implementation details.
Pre-Processor Checks
1. The program checks for any 3-armed nodes and informs the user in the log file. A 3-
armed node, would in reality, be replaced by a junction, which might interact with the
surrounding components.

October 2020
2. The program checks the diameters of adjacent components and warns the user if they
differ by more than 5%. Again, in reality this would imply the use of a diffuser or
reducer, with possible interaction effects.
Pre-Calculation of Coefficients
1. The program searches for pairs of potentially interacting components whose interaction
coefficients depend only on the geometrical configuration and flow direction and NOT
the magnitude of the flow. (This in fact includes ALL interacting components except T-
and Y-junctions and components interacting with them.)
The appropriate component interaction coefficients are stored ready to be used during
the iterative simulation of the network.
2. The program sets up the data to enable the interaction coefficients for T- and Y-
junctions and components interacting with them, to be calculated during the iterative
simulation of the network.
Iterative Calculation of Coefficients after Flow and Pressure Convergence

The iterative simulation then proceeds normally except that loss coefficients are multiplied by
the stored component interaction coefficients where appropriate, but excluding interaction
involving T- and Y-junctions.
After flow and pressure convergence, if T- and Y-junctions are present the program restarts the
iterations, but this time it includes the coefficients for these components. The calculation
continues until the flows and pressures converge. (This approach avoids lengthy, time
consuming calculations during the majority of the iterative process and enables the T- and Y-
junction coefficients to incorporated efficiently.)
Output Facilities
The component interaction coefficients are output as operational variables, one each for bends,
orifices, gradual diffusers/reducers and sudden diffusers/reducers, three each for T- and Y-
junctions. A 'component interaction' message is displayed alongside each component which has
a non-unity interaction coefficient on the network results display. (A coefficient of 1.0 implies
no interaction since the coefficients are multiplied.)
Combination Angles
When bends or pumps are attached to bends, T-junctions or Y-junctions, the 'combination angle'
between the components is required in order to calculate the interaction coefficient. For bends/
junctions there is one combination angle per arm in the input data. For junction/bend/pump
combinations, you must specify the combination angle on the bend or junction data form.
For junction/bend-bend combinations, you may specify the combination angle on either
component's data form. If you specify the combination angle on both forms, then the angles

October 2020
MUST be within one degree of each other - otherwise the program assumes that you have input
two different values for one angle and will error halt. The arm number (1, 2 or 3) on the
component data form relates directly to the number shown on the component symbol.
Note
Where combination angles are NOTSET, an angle of zero is assumed by the simulation and
a warning is issued.
Definition of Combination Angle Between Two Bends

In the extreme cases shown in Figure 22-1 A and B with bends 1 and 2 both in the plane of the
paper, θc = 0o and 180o respectively. If bend 1 is in the plane of the paper, and bend 2 is not (see
Figure 22-1 C) then θc is the angle through which bend 2 has been rotated in getting from A to
C. Note that 0≤θ≤180o; θ does not depend on the direction of rotation.

October 2020
Figure 22-1. Defining Combination Angles for Bends
Definition of Combination Angle for Components Attached to Junctions

Referring to Figure 22-2, for components attached to T- and Y-junctions, the combination angle
is defined by imagining two of the arms of the junction making a bend. If the component is
attached to arm 1, use arms 1 and 2 to make the imaginary bend, otherwise use arm 1 and the

October 2020
arm to which the component is attached. The combination angle is then defined as being the
combination angle between the attached component and the imaginary bend.
Figure 22-2. Defining Combination Angles for Junctions
Definition of Combination Angle for Pumps

For components attached to pumps, an imaginary bend is formed by considering the path of the
fluid as it rotates through the pump and exits through the outlet pipe. The combination angle is
then formed by using this imaginary bend in place of the pump. In this example, θc.

October 2020
Running a Component Interaction Simulation
Figure 22-3. Defining Combination Angles for Pumps

Once you have entered the relevant component data and specified the general conditions, you
can then run a simulation on the network.
Flow rates and other variables are calculated throughout the network. The results provide the
following information:
• Volumetric flow rate at each branch

• Velocity at each branch
• Interaction coefficients for interacting components

October 2020
Figure 22-4. Running Component Interaction Simulations

October 2020
Flow direction is defined as:

Table 22-3. Component Interaction Simulations - Flow Conventions
Flow Direction Components
Positive out of a component for 1-armed components
Positive from connection point 1 to 2 for 2-armed components
Positive out of the components for all arms for 3-armed components

October 2020

October 2020
Chapter 23
Drive Cycles
A Drive Cycle describes the driving conditions for a vehicle (e.g. car, bus, lorry, etc) over a
given time range and speed.
Table 23-1. Drive Cycle Examples

Drive Cycle Description
Engine Start-up Involves idling the engine for a period of time, for example
20 seconds, then gently accelerating to a speed of 20 - 25
mph for another period of time.
Accelerate gradually Involves accelerating the vehicle gradually to a speed, of
for example 32 mph within 35 seconds, then decelerating to
0 mph in 10 seconds and idling for 40 seconds.
Accelerate at part throttle Involves accelerating the vehicle to 25 mph in 10 seconds,
and then cruising at 17-25 mph for 15 seconds. The vehicle
is then accelerated gradually to 57 mph in 45 seconds and is
then held a cruising speed of 50 mph for 1 minute. Finally,
the vehicle is decelerated gradually to 0 mph in 40 seconds
and is then idled for 15 seconds.
Drive Cycles are presented as Speed v Time curves, each describing a particular set of driving
conditions.
The drive cycles provided by Simcenter Flomaster can be found in the Performance Data
catalogue, and are grouped as follows:
Table 23-2. Simcenter Flomaster Drive Cycles
European Union Braunschweig Cycle
ECE/UDC
ETC (FIGE Transient)
EUDC
EUDC (Low Power)
New European Drive Cycle (ECE + EUDC)
New European Drive Cycle (Low Power)
International Nonroad Transient Cycle (NRTC)
World Harmonized Transient Cycle (WHTC)

October 2020
Drive Cycles
Table 23-2. Simcenter Flomaster Drive Cycles (cont.)

Japan 10-15 Mode Cycle
10-Mode Cycle
JC08
JC05
United States Arterial Commuter (BAC) - Arterial Segment
Business Arterial Commuter (BAC) - Commuter Segment
California Unified Cycle (UC, LA92)
Central Business District (CBD)
City Suburban Heavy Vehicle Cycle (CSHVC)
CSVL
CTA
FTP 72
FTP 75
FTP Transient
Heavy Heavy-Duty Diesel Truck (HHDDT) Creep Mode
Heavy Heavy-Duty Diesel Truck (HHDDT) Cruise Mode
Heavy Heavy-Duty Diesel Truck (HHDDT) Transient Mode
Highway Fuel Economy (HWFET)
IM240
Manhattan Bus Cycle
New York Bus Cycle (NY Bus)
New York City Cycle
New York Composite
Orange County Bus Cycle
SFTP SC03
SFTP US06
Urban Dynamometer Driving Schedule (UDDS)
WVU 5-Peak

October 2020
Chapter 24
Flow Balancing
Flow Balancing enables you to specify required flow rates in a network. For Incompressible
simulations, these flow rates are Volumetric (m3/s) in nature. For Compressible simulations,
you specify the mass flow rate (kg/s). From this, the pressure and flows within the network are
calculated enabelling component data to be determined, which in turn enables the required
flows to be achieved.
Definitions
• Balancing component - a component that the simulation identifies in a loop

• Flow Specifying component - a component that allows a desired flow rate (e.g. Mass
Flow Rate or Volumetric Flow Rate) to be specified, rather than geometric data.
It is recommended that at least one component is designated as a 'flow specifier'. However, in
order for a network to run successfully two rules must be satisfied:
• The flow specification must satisfy continuity within the network.

• It will not be possible to connect two flow specifiers to one another (side by side). This
is due to the fact that the pressure at their common node will be impossible to determine.
It is recommended that you do not place two specifying components in the same line, as
shown in the example below. Here, flow has been specified in the gradual transition, and
the discrete loss to determine the minor diameter of the transition and the area of the
discrete loss.
Figure 24-1. Incorrect Usage of Flow Specifying Components

October 2020
Flow Balancing
Depending on the simulation you are running (e.g. Compressible or Incompressible), the same
reasoning applies regarding the status of nodes. Generally, for nodes, you should indicate which
part of the network contains either gas or liquid by setting the node status to Compressible (e.g.
DRY) for gas, and Incompressible (e.g. WET) for liquids. In short, for Compressible
simulations, flow specifying components should be set to Compressible, while for
Incompressible simulations, flow specifying components should be set to Incompressible.
For example, in a Compressible Flow Balancing simulation any Cylindrical Pipe components
(which are flow specifiers), MUST only be connected to Compressible nodes. The simulation
will error halt if this is not the case. You are advised NOT to use pipes as flow balancing
components in the Incompressible (e.g. wet side) of the network. If you need to use pipes, then
you should consider running an Incompressible Flow Balancing simulation, which allows you
to simulate 'wet' networks.
The following general utilities have been incorporated:
• Nodal pressures can be calculated for all connection nodes of all flow specifying
components. Networks that contain two armed flow specifiers are split into sub-systems
by treating each flow specifier as two back-to-back one-armed flow specifiers. Each
subsystem is then examined to ensure that the pressure can be specified at one or more
nodes.
Tip
One method of separating a pressure source from a flow specifying component is by
placing a Discrete Loss component in between. This component will have low
forward and reverse loss coefficients and a relatively high area so as to simulate a
lossless component (see Figure 24-2).

October 2020
Flow Balancing
Figure 24-2. Flow Balancing - Example Networks
• A two armed flow source coefficient routine has been incorporated for both
compressible and incompressible flow. This routine is used for the flow specified
components. In the case of compressible flow this routine ensures that the network does
not attempt to solve with an impossible mass flow rate.
If this occurs, then the simulation will error halt and a warning message will be
generated indicating that the network has failed to achieve a 'flow balanced' state.
• A Steady State network simulation will be repeated after the initial Flow Balancing
geometry calculation has run, where newly calculated items of geometric data are used
in place of the specified mass flow rates.
The following points should be noted when running a Flow Balancing simulation.
• If the desired flows are not achievable due to choking at critical area locations, then the
simulation will error halt at the end of the initial Flow Balancing geometry calculation
and a warning is issued. For example:
"Mass flow rate not achievable for the flow specifier"
• Calculated geometry (for example, a diameter or length, depending on the component) is
checked to determine if the minimum and maximum allowable range has been used for
the relevant data item. (This range can be seen near the bottom left of the Component
Data Form.) If the minimum or maximum range has been exceeded, then a warning is
given.

October 2020
Flow Balancing
Flow Balancing - Which Components Can I Use?
• All flow specifying components must be considered as adiabatic before their geometric
details are to be determined. A simulation will be repeated and the subsequent geometry
found if any flow specifying component is set-up with heat transfer. It is important to
note that the eventually derived mass flow rate may be found to differ slightly from that
required.
• For flow balancing simulations that include components which use a curve, accurate
results will only be achieved if the curve is invertible in the full range of use.
Within Flow Balancing, a flow direction is defined as:
• Positive out of a component for one-armed components.

• Positive from branch 1 to branch 2 for two-armed components.
Flow Balancing - Which Components Can I Use? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Flow Balancing - Which Components Can I

Use?
There is a range of components can be used as 'flow specifying', i.e., components which allow a
desired mass, or volumetric flow rate to be specified in place of certain items of geometric data.
Table 24-1. Flow Balancing - Available Components

Component Catalogue Component Type
Accumulators Accumulator: Air Vessel
Accumulator: Bladder - Variable Geometry
Aerospace - Environmental Cd Valve
Control Systems
Losses Loss: Discrete
Orifice: Sharp-edged (Conical & Standard Orifice Plate)
Orifice: Long
Orifice: Radiussed
Orifice: Square
Pipes: Cylindrical Pipe: Cylindrical Bubbly
Pipe: Cylindrical Compliant
Pipe: Cylindrical Elastic
Pipe: Cylindrical Rigid

October 2020
Flow Balancing
Table 24-1. Flow Balancing - Available Components (cont.)

Pipes: Hexagonal Pipe: Hexagonal Bubbly
Pipe: Hexagonal Compliant
Pipe: Hexagonal Elastic
Pipe: Hexagonal Rigid
Pipes: Prismatic Pipe: Prismatic Bubbly
Pipe: Prismatic Compliant
Pipe: Prismatic Elastic
Pipe: Prismatic Rigid
Pipes: Rectangular Pipe: Rectangular Bubbly
Pipe: Rectangular Compliant
Pipe: Rectangular Elastic
Pipe: Rectangular Rigid
Pumps Pump: Axial Flow
Pump: Mixed Flow
Pump: Radial Flow
Reservoirs Reservoir: Constant Head
Reservoir: Finite Area
Reservoir: Infinite Area
Reservoir: Variable-Head
Valves: Control Valves Valve: Angle
Valve: Ball
Valve: Butterfly (Types A, B, C and Blakeborough)
Valve: Y
Valve: Diaphragm (Full Bore and Reduced Bore)
Valve: Gate
Valve: Globe
Valve: Sluice
Valve: Poppet-Relief
Valve: Swing-Check
Valves: Check and Relief Valve: Poppet-Relief
Valves Valve: Swing-Check

October 2020
Flow Balancing
Table 24-1. Flow Balancing - Available Components (cont.)

Weirs Weir: Broad-Crested
Weir: Sharp-edged Rectangular
Weir: V-notched
Loss Data
The basis for the loss data for the families shown above is the incompressible loss data
presented in 'Internal Flow Systems'. This data is regarded as the best that is currently available,
there being very little reliable compressible flow component loss data available. The
incompressible loss data is revised where appropriate to cater for fluid compressibility effects.
Additional Features
The following table shows the additional features for all components that are classed as 'flow
specifiers'.
Table 24-2. Flow Balancing Components - Additional Results and Features
Component New Data Omitted Data Additional Results
Compressible Pipes
Cylindrical Mass Flow Diameter or • Required total pressure loss
Pipes Rate Length Diameter • Required loss coeff. (Comp) dry
or Length • Required loss coeff. (Incomp) wet
• Specified mass flow rate.
Incompressible Pipes
Cylindrical Volumetric Diameter or • Diameter or Length
Pipes Flow Rate Length • Specified flow
• Required pressure loss
• Actual pressure loss
• Loss coefficient.
Hexagonal Volumetric Side Length, or • Side Length or Length
Pipes Flow Rate Length • Specified flow rate

October 2020
Flow Balancing

Prismatic Volumetric Area, Length or • Area, Length or Perimeter
Pipes Flow Rate Perimeter • Specified flow rate
Rectangular Volumetric Width, Length or • Width, Length or Breadth
Pipes Flow Rate Breadth • Specified flow rate
Valves
Control Mass or Diameter or Compressible
Valves Volumetric Position • Required total pressure loss
Flow Rate
• Required loss coeff. (Comp) dry
• Required loss coeff. (Incomp) wet
• Specified mass flow rate
• Selected diameter and Valve position.
Incompressible
• Position
• Specified flow rate
• Loss coefficient
• Selected position.
Cd Valves Mass or Specified mass • Diameter or Position
Volumetric flow rate • Required pressure loss
Flow Rate • Required loss coefficient dry
• Selected diameter
• Selected position
Orifices

October 2020
Flow Balancing

All Orifices Mass or Orifice Diameter Compressible
Volumetric • Selected diameter
Flow Rate
• Required total pressure loss
Incompressible
Discrete Losses
Discrete Loss Mass or Area Compressible
Volumetric • Selected Area
Flow Rate
• Required total pressure loss
Incompressible
Compressible Pumps
Compressor/ Mass or All other data can Required total pressure gain1
Fan Volumetric be omitted
Flow Rate
1. Required pressure gain calculated, but left to user to select features which correspond to these conditions.A
Compressor/Fan simulation as such is not performed.

October 2020
Chapter 25
Ambient Conditions
The Ambient Conditions applies to all simulations and can be specified in a number of ways
The Ambient Conditions data is set on the Ambient Conditions Sub-Form on the Simulation
Data tab. All types of Simulation require both Ambient Temperature and Atmospheric Pressure
to be defined, either directly or via a definition of Altitude and its relationship to these
parameters. Ambient Temperature and Atmospheric Pressure can each be defined in one of
three ways:
• As a constant (Real) value

• As a curve v Time
• As a curve v Altitude
If you use this method the Altitude must also be defined, which can be done in one of
two ways:
o As a constant (Real) value
o As a curve v Time
Context Dependency Rules apply as to how the Ambient Temperature and Atmospheric
Pressure are specified. The following tables show how Simcenter Flomaster prioritizes the data
for Steady State and Transient use:
Table 25-1. Context Dependency Rules for Ambient Temperature
1 2 3 4
Steady State
Altitude (Constant Altitude v Time Ambient Ambient v Time
[real]) (evaluated at tstart) Temperature (evaluated at tstart)
Ambient (Constant [real])
Ambient
Temperature v Temperature v
Altitude Altitude
Transient
Altitude v Time Altitude (Constant Ambient Ambient
Ambient [real]) Temperature v Time Temperature
Temperature v Ambient (Constant [real])
Altitude Temperature v
Altitude

October 2020
Ambient Conditions
Ambient Conditions - Parameter Definitions
Table 25-2. Context Dependency Rules for Atmospheric Pressure

1 2 3 4
Steady State
Altitude (Constant Altitude v Time Atmospheric Atmospheric
[real]) (evaluated at tstart) Pressure (Constant Pressure v Time
Atmospheric [real]) (evaluated at tstart)
Atmospheric
Pressure v Altitude Pressure v Altitude
Transient
Altitude v Time Altitude (Constant Atmospheric Atmospheric
Atmospheric [real]) Pressure v Time Pressure (Constant
Pressure v Altitude Atmospheric [real])
Pressure v Altitude
Ambient Conditions - Parameter Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610

Ambient Conditions - Simulation Descriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612

Parameters to be used for ambient condition simulations.
• Ambient Temperature
A constant value of the temperature present on the outside of the Simcenter Flomaster
circuits and components. It is the default temperature for inflow at many boundaries and
for the external temperature of components, unless a local value is set to override it.
Default = 20oC
• Atmospheric Pressure
A constant value of the pressure acting on the outside of the Simcenter Flomaster
circuits and components. It is the default pressure at most boundaries and some other
components, unless a local value is set to override it.
Default = 1.01325 bar
• Acceleration due To Gravity (g)
The body force applied in all Simcenter Flomaster simulations, due to the gravitational
attraction of the earth. The default value is equal to the Standard Gravity (exactly
9.80665 m/s2) agreed by the 3rd CGPM in 1901. You can override this to account for
local variations in gravity.
Default = 9.80665 m/s2

October 2020
Ambient Conditions
• Altitude
A constant value of the elevation above Mean Sea Level (strictly the geopotential
height) of the systems being modeled. A single value is used for the entire network,
since hydrostatic effects are not modeled in the atmosphere around the circuits. Altitude
is solely used to evaluate Ambient Temperature and/or Atmospheric Pressure from the
appropriate curve v Altitude.
Default = NOTSET
• Ambient Temperature v Time
The time-varying temperature present on the outside of the Simcenter Flomaster circuits
and components. It is the default temperature for inflow at many boundaries and for the
external temperature of components, unless a local value is set to override it.
Default = NOTSET
The time-varying pressure acting on the outside of the Simcenter Flomaster circuits and
components. It is the default pressure at most boundaries and some other components,
unless a local value is set to override it.
Default = NOTSET
• Altitude v Time
The time-varying elevation above Mean Sea Level (strictly the geopotential height) of
the systems being modeled. A single value is used for the entire network, since
hydrostatic effects are not modelled in the atmosphere around the circuits. Altitude is
solely used to evaluate Ambient Temperature and/or Atmospheric Pressure from the
appropriate curve v Altitude.
Default = NOTSET
The temperature of the atmosphere as a function of Altitude above MSL. A curve is
supplied in the database, which is based on the International Standard Atmosphere (ISA)
of the International Civil Aviation Organization (ICAO).
Default = ISA Temperature v Altitude
• Atmospheric Pressure v Altitude
The pressure of the atmosphere as a function of Altitude above MSL. A curve is
supplied in the database, which is based on the International Standard Atmosphere (ISA)
of the International Civil Aviation Organization (ICAO).
Default = ISA Pressure v Altitude

October 2020
Ambient Conditions
Ambient Conditions - Simulation Descriptions

Simulation descriptions for ambient temperature and pressure.
Ambient Temperature
Ambient Temperature is used to initialize all components in a Heat Transfer or Compressible
simulation, for those components that DO NOT have an independent initial temperature. It is
used as a 'default' setting for:
• The independent initial temperature in: Accumulators

o Blow-down Tanks
o Compressible Cylinders
o Fixed Volume
o Point Mass
o Reservoirs of a defined volume.
• The ambient/exterior/external temperature of:
o Three-armed Reservoirs
o Expansion Tanks, or Degas Bottles
o All Hoses, Pipes and Passages.
• The constant temperature in:
o Reservoirs of an undefined volume
o In the stream leaving a source component.
• The reference temperature in materials.
Atmospheric Pressure
Atmospheric Pressure is used as a 'default' setting for:
• The surface pressure in:

o Reservoirs
o Weirs
o Water Separator
• The external pressure for the:
o Accumulator: Vented Air

October 2020
Ambient Conditions
o Heat Exchanger: Main CW Condenser

o Valve: Gas Admission/Release
• The pressure of a:
o Source: Pressure
o Source: Exhaust Volume
o Stagnation Pressure Source
It is also used to initialize certain types of Accumulator and to calculate the unbalanced pressure
on Single-acting Cylinders. All these conditions are detailed in the Reference Help for the
relevant component.
Altitude
If the Altitude is defined, either as a constant or as a curve v Time, it is used to:
• Set Atmospheric Pressure, if the curve of Atmospheric Pressure v Altitude is set.

• Set Ambient Temperature, if the curve of Ambient Temperature v Altitude is set.

October 2020
Ambient Conditions

October 2020
Chapter 26
Zero Flow Heat Transfer
The prime aim of modeling Zero Flow Heat Transfer (ZFHT), is to help engineers improve the
performance of engine cooling systems. Key to these improvements, is having a well balanced
warm-up strategy, where the aim is to reduce the friction losses in the liners and bearings. To
achieve this, parts of the cooling circuit are temporarily 'closed off' from the coolant flow by
valves, thermostats or by the switchable/electric coolant pump itself.
As a result of this certain parts of the cooling circuit, convective heat transfer from these parts to
the surrounding structure is significantly reduced which in turn improves engine warm-up. To
prevent over-heating and to restart the coolant flow, temperature sensors which form an integral
part of the control circuit, are placed in the 'zero flow' parts of the cooling circuit.
Zero Flow Heat Transfer - Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615

Modeling Zero Flow Heat Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Zero Flow Heat Transfer - Thermally Neutral Components . . . . . . . . . . . . . . . . . . . . . 619
Zero Flow Heat Transfer - Components

There is a range of components capable of modeling zero flow heat transfer.
• Automotive: Engine Cooling
o Map Controlled Thermostat: 2-Arm
o Map Controlled Thermostat: 3-Arm
• Bends
o Bend: Circular
o Bend: Circular Mitre
o Bend: Circular Composite Mitre.
• Junctions
T-junctions
o Junction: T(30o)
o Junction: T(45o)
o Junction: T(60o)

October 2020
Zero Flow Heat Transfer - Components
o Junction: T(90o)
Y-junctions
o Junction: Y (A1 + A2 = A3)*
o Junction: Y (A1 = A2 = A3)*.
• Losses
o Discrete Loss*
• Heat Exchangers
o Heat Exchanger: Heater-Cooler
o Heat Exchanger: Thermal
• Pipes
o Pipe: Cylindrical Rigid*
o Pipe: Flexible Hose*
• Sources
o Source: Flow
o Source: Pressure
• Solids
o Thermal Bridge*
• Valves
Control Valves
o Valve: Y*
o Valve: Angle*
o Valve: Ball*
o Valve: Butterfly (Blakeborough)*
o Valve: Butterfly (Type A, B, and C)*
o Valve: Diaphragm (Full Bore)*
o Valve: Diaphragm (Reduced Bore)*
o Valve: Gate (Seat Area = Pipe Area)*
o Valve: Globe*
*These components also have the additional convection heat transfer capabilities.

October 2020
Modeling Zero Flow Heat Transfer

Guidance on modeling Zero Flow Heat Transfer (ZFHT).
The following assumptions are made:
• Zero-flow calculations are only activated for those components shown in the above
table. As such, any zero-flow branches in the network can ONLY contain these
components.
• If the network contains a 2-Arm component for which zero-flow calculations are not
implemented, it is considered as a 'thermally neutral' component.
• In the case of a 1-Arm or a component with more than two arms, for which zero-flow
calculations are not implemented, then the simulation halts and an error message is
displayed.
• Nodes present in zero-flow branches can only have two components attached to them. If
more than two components are required to be attached, then the node will have to be
replaced with a Junction component.
For those components where Zero Flow Heat Transfer is modeled, the Solid Bar Conduction
model is used. Depending on the component type, ZFHT is modeled both axially and radially.
Figure 26-1. Zero Flow Heat Transfer Modelling
Component Data
Table 26-1. ZFHT Component Data Requirements
Application/ Component Type ZFHT Sub-form
Component Family Settings
Automotive: Engine Map Controlled Thermostat: 2-Arm Axial HTC
Cooling Map Controlled Thermostat: 3-Arm Thermal
Conductance

October 2020
Table 26-1. ZFHT Component Data Requirements (cont.)

Application/ Component Type ZFHT Sub-form
Component Family Settings
Bends Bend: Circular Axial HTC
Bend: Circular Mitre Radial HTC
Bend: Circular Composite Mitre
Control Valves Valve: Y Axial HTC
Valve: Angle Thermal
Valve: Ball Conductance
Valve: Butterfly (Blakeborough)
Valve: Butterfly (Type A)
Valve: Butterfly (Type B)
Valve: Butterfly (Type C)
Valve: Diaphragm (Full Bore)
Valve: Diaphragm (Reduced Bore)
Valve: Gate (Seat Area = Pipe Area)
Valve: Globe
Junctions Junction: T(30o) Axial HTC
Thermal
Junction: T(45o)
Conductance
Junction: T(60o)
Junction: T(90o)
Junction: Y (A1 + A2 = A3)
Junction: Y (A1 = A2 = A3)
Heat Exchangers Heat Exchanger: Heater-Cooler Axial HTC
Heat Exchanger: Thermal Path 1→ 2 Axial and
Radial HTC
Path 3 → 4 Axial and
Radial HTC
Pipes Pipe: Cylindrical Rigid Axial HTC
Pipe: Flexible Hose Radial HTC
Solids Thermal Bridge Axial HTC
Radial HTC

October 2020
Zero Flow Heat Transfer - Thermally Neutral Components
Simulation Data
Table 26-2. ZFHT Simulation Data Requirements
Property Setting
Simulation Type Heat Transfer Steady State or Heat Transfer Transient
Zero Flow Heat Transfer Yes
Enabled
Convergence and Tolerance Criteria (Sub-Form)
Min. Flow Tolerance Unless the flow rate calculated in any component is less
than the tolerance value, then ZFHT calculations will not be
performed for that component. As such, the tolerance value
needs to properly selected - preferably based on the results
from an Incompressible Steady State or Transient
simulation.
Min. Temperature Tolerance This should be set to a 'low' value (e.g. 0.01), as the
temperature variations under zero flow conditions are very
small.
Min. Heat Flow Tolerance This should be set to a 'low' value (e.g. 1E-06).
Maximum Number of This should be set to a high value (e.g. 1000 or 10000
Iterations iterations for larger networks), due to the tighter tolerances
imposed on the temperature and Heat flow results.
Zero Flow Heat Transfer - Thermally Neutral

Components
Those components that do not model ZFHT, are classed as being 'thermally neutral'. As such,
they have negligible thermal resistance, and minimal temperature difference between their
arms.
Other Components
Therefore, both T1 and T2 should be equal within:
(26-1)

October 2020
Zero Flow Heat Transfer - Thermally Neutral Components
Where:
(26-2)
If we compare:
(26-3)
then:
(26-4)

October 2020
Chapter 27
1D Heat Transfer
You can use 1D Heat transfer to model heat along the length of certain components.
Simcenter Flomaster calculates the external temperature at the component interface.
Figure 27-1. 1D Heat Transfer - Components Exchanging Heat
The following components can model 1D Heat Transfer:
• Bubbly, Compliant, Elastic, and Rigid Pipes (all cross-sectional variations)

• Bend: Circular
• Passage: Rotating
• 1D Heat Transfer Rate Profile
• 1D Temperature Profile
Note
1D Heat Transfer is not available when modelling complex phase networks.
There are three 1D Heat Transfer specific components that you can use when modeling this
behavior.

October 2020
1D Heat Transfer
Modeling 1D Heat Transfer
• 1D Heat Transfer Rate Profile
• 1D Temperature Profile
• Pipe Run
Note
You can create components that model 1D Heat Transfer from scripts. See the Simcenter
Flomaster N-Arm Scriptable Components Getting Started Guide for information on creating
scripted components.
Modeling 1D Heat Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622

Applying a Temperature Profile to a 1D Heat Transfer Network . . . . . . . . . . . . . . . . . 627
Applying a Heating Profile to a 1D Heat Transfer Network . . . . . . . . . . . . . . . . . . . . . . 628

You can use the 1D Heat Transfer Rate Profile, 1D Temperature Profile, and Pipe Run
components to control how Simcenter Flomaster collects, manages, and applies temperature and
heating profiles along components and runs of components.
• The Pipe Run component is used to collect one or more 1DHT compliant components
into a series of lengths and manage the 1D heat transfer along the length of the run.
The Pipe Run component can interact with a 1D Heat Transfer Node, the 1D
Temperature Profile component, or 1D Heat Transfer Rate Profile component.
• 1D Heat Transfer Nodes represent a 1D thermal boundary between 2 or more
components.
• The 1D Temperature Profile component applies a temperature profile to a pipe run.
• 1D Heat Transfer Rate Profile component applies a heating profile to a pipe run.
Setting Up a Pipe Run

To specify the pipes included in, and so controlled by, the Pipe Run component click the in Pipe
Run Components field.

October 2020
1D Heat Transfer
The Pipe Run Components dialog opens.
Figure 27-2. Modeling 1D Heat Transfer - Example Network
In the network above the Pipe Run component (Component 3) has been set to include
components 12 and 4. Components 12 and 4 now then 1D Heat Transfer. They continue to use

October 2020
1D Heat Transfer
their own thermal models but instead of calculating the external temperature – this is calculated
at the 1D Heat Transfer node (Node 7). In this network, the node will balance he heat flow
between pipe run 3 and pipe run 2.
Pipe Run Colors

In Networks containing multiple Pipe Runs, you can use the 1D Heat Transfer Color button to
identify which components are associated with each Pipe Run.
In the example below:
• The color around Pipe Component 1 and Pipe Run Component 2 is same (red), showing
that Pipe Component 1 is associated with Pipe Run Component 2.
• Pipe Components 4 and 12 and Pipe Run Component 3 are the same color (green),
showing that they are all associated.
• The arrow represents the direction of heat flow. You can specify this in the Pipe Run's
'Pipe Run Components' sub-form.
Note
You can specify the color of any Pipe Run groups by right-clicking on the Pipe Run
component and choosing Set Pipe Run Color.

October 2020
1D Heat Transfer
Figure 27-3. Modeling 1D Heat Transfer - Pipe Run Colors
Typical Pipe Run Results

Typical results are shown in Figure 27-4 and Figure 27-5. In this scenario, the flow at the top is
flowing left to right. The flow at the bottom is flowing left to right. So, this models co-flow heat
exchange. It can be seen that the top flow is hotter and cools as it flows to the right. Likewise
the bottom flow heats as it flows to the right.
Note
This network is set up under the assumption that both pipes are exchanging heat over their
full external area.

October 2020
1D Heat Transfer
Figure 27-4. Modeling 1D Heat Transfer - Temperature Results
Figure 27-5. Modeling 1D Heat Transfer - Mass Flow Results

October 2020
1D Heat Transfer
Applying a Temperature Profile to a 1D Heat Transfer Network
Applying a Temperature Profile to a 1D Heat

Transfer Network
Use the 1D Temperature Profile component, applied to a Pipe Run component, to specify a
temperature profile.
Within the 1D Temperature Profile component, set the component ID of the pipe run to which
the temperature profile is to be applied.
• Temperature - A fixed temperature to be specified across the whole length

• Temperature v Length – A curve to specify the temperature profile for the external
temperature of the pipe run
• Temperature v Length v Time – A surface to specify a temperature profile and how it
changes with time
Figure 27-6. Applying a Temperature Profile to a 1D Heat Transfer Network -
Example Network
The External Temperature results show a step wise profile due to the pipe segmentation. Each
step is a pipe segment.

October 2020
1D Heat Transfer
Applying a Heating Profile to a 1D Heat Transfer Network
Figure 27-7. Applying a Temperature Profile to a 1D Heat Transfer Network -

Results
Applying a Heating Profile to a 1D Heat

Transfer Network
Use the 1D Heat Transfer Rate Profile component, applied to a Pipe Run component, to specify
a heating profile.
Within the 1D Heat Transfer Rate Profile component, set the component ID of the pipe run to
which the heating profile it is to be applied.
• Heat Transfer Rate per Unit Length - A fixed heating rate to be applied across the whole
length of the pipe run.
• Heat Transfer Rate per Unit Length v Length – A curve to specify the heating profile
along the length of the pipe run.

October 2020
1D Heat Transfer
• Heat Transfer Rate per Unit Length v Length v Time – A surface to specify the heating
profile and how it changes with time.
Note
Heating is specified as Power per Unit Length

October 2020
1D Heat Transfer

October 2020
Chapter 28
Geographic Information Systems
You can import Geographic Information System (GIS) data files into Simcenter Flomaster.
GIS data comprises:
Table 28-1. GIS Import Tool Overview
Shape file (.shp) The primary geographical reference data in digital vector
format. Geometric data is presented as geometrical data types
such as Points, Lines and Polygons.
Projection File (.prj) Contains the coordinate details of the geometric data contained
in the .shp file.
Attribute File (.dbf) Contains the attributes for each shape inthe .shp file (in dBase
format).
Index File (.shx) Contains an index for each geometric feature. This file is not
used by Simcenter Flomaster and is not imported during the
GIS import process
Note
The contents of the .dbf file are referred to (commonly and in this documentation) as the
'metadata'.
Importing GIS Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632

Selecting the GIS Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
GIS Pipeline Import - Reviewing and Modifying the Imported Metadata . . . . . . . . . . . . . 633
Setting the Simcenter Flomaster Pipe Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
Importing Data from the Metadata File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
Viewing the Pipe Runs, Elevations and Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641

October 2020
Importing GIS Files
Importing GIS Files

Simcenter Flomaster contains a GIS Import tool which you can use to select the GIS files,
review the pipe and shape data, assign Simcenter Flomaster component types to the GIS data,
and create a Simcenter Flomaster Network.
Selecting the GIS Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
GIS Pipeline Import - Reviewing and Modifying the Imported Metadata . . . . . . . . . . 633
Setting the Simcenter Flomaster Pipe Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
Importing Data from the Metadata File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
Viewing the Pipe Runs, Elevations and Curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
Selecting the GIS Files

Use the GIS Import tool to select the GIS files for import.
Prerequisites
• A GIS import enabled license.
• GIS data - A shape file (.shp), a projection file (.prj), and a metadata file (.dbf).
Procedure
1. Open the GIS Pipeline Import tool from Tools > Import Tools > GIS Import Tool.
2. Select the shape file by clicking the [...] button next to the Shape File field.
a. Navigate to the folder where the Shape File (.shp) is stored, and select the file.
b. If the Projection file (.prj) and the Metadata file (.dbf) are in the same folder as the
Shape file (.shp), they will be automatically added to the Projection File and
Metadata File fields. If these files are stored elsewhere click the relevant [...] button
and navigate to the .prj and .dbf files.
The pipe lengths and diameters specified in the shape file are read in SI units and
then converted to the current Simcenter FlomasterSimcenter Flomaster unit set.
When importing elevation data, Simcenter Flomaster will use the default unit for Level
as specified in the current Unit Set, regardless of the units specified in the .shp file.
If the units in the .shp file and current Simcenter Flomaster Unit Set do not match you
must either:
• Update the Level entry in the current Simcenter Flomaster Unit Set to the same units
as the elevation data in the .shp file.

October 2020
GIS Pipeline Import - Reviewing and Modifying the Imported Metadata
• Apply a new Unit Set which contains the same units for Level as the elevation data
in the .shp file.
For more information on using Unit Sets see “Maintaining Units” on page 788
3. Click the Import button.
Results
The piping network is displayed in the right-hand pane.
GIS Pipeline Import - Reviewing and Modifying the

Imported Metadata
You can view imported pipe shape data and Metadata. You can edit any item of metadata but,
only Diameter, Roughness, Wave Speed, and Wall Thickness are imported into
Simcenter Flomaster. If required you can split the GIS pipes in to smaller runs which can then
be mapped to multiple Simcenter Flomaster pipe components.
Prerequisites
• Imported GIS data.
Procedure
1. Click the Shape Data... button to open the Shape Data (WGS 84 coordinates) dialog
box.
The dialog box shows the following details:
• Part No. - a part defined in the shape file. Usually a pipe.
• Point - a point at which coordinate data is provided.
• Pipe No. - the pipe that corresponds to the same part.
• Pipe Point - defined in 3D space, it is the GIS coordinate point along the pipe.
• Latitude, Longitude and Level - these are derived from the Pipe Point information.
• Segment - referring to Figure 28-1, the distance between points along the pipe.
• Segment Length - referring to Figure 28-1, the sum of the distances for each point.

October 2020
GIS Pipeline Import - Reviewing and Modifying the Imported Metadata
Figure 28-1. Defining Segments
2. Review the shape data. If required you can split the pipes.
Spitting long pipes into smaller sections can help with managing complex pipe runs and
allows you to alter the parameters for sub-sections of the pipe.
You can split pipes by either:
• Setting Split Points - this allows you add a split at specific coordinates along the
pipe.
• Setting a Split at Specified Points.
To set split points:
a. Click the Set Split Point Coordinates button.
The Break Point Locations dialog box opens.
b. Select the WGS 84 - this is the World Geodetic System, which is wildly used in
cartography, geodesy and navigation applications or Projection File - this is based
on the Latitude and Longitude information stored in the shape file option.
c. Enter the required details, and then click OK.
To split the pipe at a specified point:
a. Click the check box next to the required pipe.
b. Click the Split at Specified Points button to apply the split
3. Close the Shape Data (WGS 84 coordinates) dialog box.
4. Review the Metadata by clicking the Metadata... button.

October 2020
Setting the Simcenter Flomaster Pipe Model
The Metadata dialog box opens.

Figure 28-2. The Metadata Dialog Box
The data held in the Metadata file is 'source dependent', i.e. it will be different for
different data files.
In the example above:
• ID: this could be a 'user-defined' part number.
• Length: the length of each part/pipe derived from the shape file.
• OD: if present, it identifies the Outside Diameter of each corresponding part/pipe.
• WT: if present, it identifies the Wall Thickness of each corresponding part/pipe.
• Material: if present, it would identify the material type for each part/pipe.
• Name: this could be the name assigned to a particular pipe in a section of a large
network.

When using GIS data you must assign Simcenter Flomaster components to each of the parts of
the GIS data.
Prerequisites

October 2020

Procedure
1. Click the Part/Pipe Data button to display the dialog box shown below:
Figure 28-3. The Part Data Dialog Box
For each Part/Pipe you can choose a Simcenter Flomaster pipe:

a. Click the Simcenter Flomaster Pipe Model button.
The Select the required pipe type dialog box opens.
b. Navigate to the required pipe type and click the Select... button to assign it to the
GIS pipe.

October 2020
Importing Data from the Metadata File
Tip
You can set all or some the successive pipes to be of the same type by choosing
Duplicate value to all rows or Duiplicate value to selected parts or pipes...
from the right-click menu.
2. Click the Close button to save any changes and close the Part Data dialog box.
3. You can add pressure sources, which act as boundary components, to any pipes with
unterminated ends by checking the Add Boundary Components option.

You can import component data from the Metadata file (provided as part of the GIS data set).
Imported data will depend on what data is held in the Metadata file.
There is a defined mapping relationship between the data in the Metadata file and the fields in
the Part Data dialog box.

October 2020
Figure 28-4. The Part Data Dialog Box
Note
The steps shown below detail the procedure for importing the 'Diameter'.
Prerequisites
Procedure
1. Open the Part Data dialog box by clicking the Part / Pipe Data... button.
You can use an existing or create a new mapping (which you can then save for future
use).

October 2020
2. To create a new mapping:

a. Click the View/Edit Metadata... button.
The MetaData dialog box opens.
Figure 28-5. The MetaData Dialog Box
b. Review the metadata to ensure that you are happy with the contents of the file.
You can edit the metadata that will be imported into Simcenter Flomaster from
within the MetaData dialog box by clicking in any field and entering the required
data.
Note
Any edits that you make here will be imported into Simcenter Flomaster but will
not be written back to the source metadata file.
c. To save the Metadata Mapping, enter a new name in the Map Name filed and then
save the file.
d. Click OK to close the dialog box.
3. To use an existing mapping
a. Choose an existing map from the Metadata Map dropdown list.

October 2020
4. Click the Define Mappings button to display the dialog box shown below:
Figure 28-6. MetaData Mappings Dialog Box
You can map any item in the Metadata Column filed to a Simcenter Flomaster feature
and specify an input unit.
5. For the item that you want to map, click in the Feature column and select a
Simcenter Flomaster feature from the dropdown list.
6. Use the Input Unit field to ensure that the correct units are selected.
7. Repeat steps 5 to 6 for all the Metadata items that you want to map.
8. Click the Save button to save the mapping.
Tip
You can also create a new Metadata Mapping by entering a new name in the Map
Name filed and then saving the file. In this instance you will be able to specify which
mapping to use from the Part Data dialog box.

October 2020
Viewing the Pipe Runs, Elevations and Curves

10. Choose a circuit type.
11. Click Close to close the Part Data dialog box.
Viewing the Pipe Runs, Elevations and Curves

You can view which pipes form a contiguous pipe group and the mile posts that you have set for
each pipe in a group.
Prerequisites
Procedure
From the GIS Pipeline import dialog box click the Pipe Runs and Elevation Curves button.
The Contiguous Pipe Groups dialog box opens.

Figure 28-7. The Contiguous Pipe Groups Dialog Box

October 2020
Creating the Network
The dialog box has two panes. The left-hand pane displays all the pipes that have one
node between them (and so form a contiguous pipe run and a group).
In the example shown above:
• There is only one pipe in Group No 1, implying that Pipe 1 is a single pipe that does
not connect to another.
• Group No 2 comprises seven individual pipes all connected to each other.
Pipe 2, the second pipe in the group, has a Mile Post setting of 3777.65. The Mile
Post setting for each of the successive pipes in the group is the sum of the length of
the previous pipes.
Because Pipe 12 is the first pipe in the group, it has no Mile Post setting.
The right-hand pane shows the profile curves that will be generated for each group.

Networks hold the components, connections, input parameters, and results. It is within networks
that you do most of your work in Simcenter Flomaster. You can create multiple networks under
each project.
Prerequisites
Procedure
1. Right-click in the bottom, left-hand pane of the GIS Pipeline Import dialog and choose
the New Network option.
Note
You can right-click over projects and sub-projects to create the new network in that
folder. You can rename the new network by right clicking over it and selecting
Rename Network.
A new network called “New Network” is created.

2. Click the Populate button. A confirmation message is displayed, and the network is
added to the owning project.

October 2020
Note
When first viewing GIS imported networks you may (depending on the geographical
data) need to re-scale the network in the drawing window by using the
Zoom to fit, , button.
For more information on working with large networks see “Moving Around the
Network Drawing window” on page 109.

October 2020

October 2020
Chapter 29
Electronic Data Interchange Facility
EDIF is a facility which enables you to set (or modify) the component, node and simulation data
in a network automatically.
To set the data, you create an EDIF file and attach the file to a batch job. When you run the
batch job via the command line, the following actions occur:
• The component data is set or updated

• The node settings are set or updated
• The Simulation data is set or updated
• The Simulation is run.
Creating and Editing EDIF Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Creating and Editing EDIF Files

EDIF is a facility which enables you to set (or modify) the component, node and simulation data
in a Simcenter Flomaster network automatically.
Prerequisites
• An open network.
Procedure
1. Select New/Edit Command Line File from the Tools menu.
The File Creation/Editing Options dialog box opens.
2. Select the EDIF option and click OK.
The Network EDIF Creation Options dialog box opens.
3. Ensure that All option is selected for components and nodes then click OK.
The EDIF File dialog box is displayed. The dialog box displays the details about
components, nodes, the Network General Data, and Simulation Control details.
4. Set the Component Data:
a. Navigate to the component of node that you want to edit by opening the Components
folder.
b. Open the component or node and then open the features folder.

October 2020
Electronic Data Interchange Facility
Creating and Editing EDIF Files
c. Edit a feature by opening the feature, clicking the [...] button and then typing a new
value into the String Collection Editor dialog box.
5. Set the Network General Data and Simulation Control Details:
a. Expand the entry and then expand the Features list.
b. Set the data items in the same way as for the components:
6. Set the Unit Set
7. Save the File by clicking OK and saving the .FMedif file in the location of your choice.
8. Create a batch file and attach it to the EDIF file

October 2020
Chapter 30
Simcenter Flomaster Direct Network
Assembly
The Simcenter Flomaster Direct Network Assembly (FMDNA) facility provides a mechanism
that allows Simcenter Flomaster to automatically create a network diagram based on a
description of its components and connectivity.
FMDNA Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
FMDNA Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Saving the File and Executing the FMDNA Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
Adding Controllers and Gauges to a Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
Adding Signal Links for a Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Adding Gauges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Using FMDNA to Create a Cavity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Creating Cavities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Defining Connections Between Components and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . 684
Defining the Eye Point Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Defining Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Defining Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
Accessing FMDNA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
FMDNA Overview
The FMDNA function builds a network by using the instructions that are defined in an FMDNA
file. These instructions, or keywords, provide details on which components and nodes are used
and how they are connected. The file also details the position of the components and how they
are viewed in the Network window.
Components and nodes, and their network number must be explicitly defined, as shown below.
Figure 30-1. Component Information

October 2020
Simcenter Flomaster Direct Network Assembly
FMDNA Overview
Figure 30-2. Node Information
In addition, you must specify the X, Y, and Z coordinates of each component and node so they
are placed in a sensible position in the network.
Figure 30-3. Specifying the X, Y, Z Coordinates
The links between the components and nodes must be defined as follows:
Figure 30-4. Link Information
In this example, the link starts at Arm 1 on Component 1 and terminates at Node 1. The
IsOrthogonal item specifies the link type, and has two settings, as described below.
Table 30-1. Link Settings and Appearance
Link Setting Link Appearance
True The link is set as Orthogonal:

October 2020
FMDNA Overview
Table 30-1. Link Settings and Appearance (cont.)

Link Setting Link Appearance
False The link is set as Straight:
Converting 3D locations to 2D Locations

When using FMDNA to construct a network, you need at least three points of reference to
define 3D objects onto a project plane, that is, the computer screen.
You have only two points to construct a network: the eye point, which defines the point from
which the diagram is viewed, and the reference point, which defines a point of reference for the
network diagram.
Defining some basic trigonometry algorithms for converting 3D objects to 2D objects illustrate
this concept more fully.
Referring to Figure 30-5, consider the following notations:
• X, Y, Z — Axes coordinates in 3D space

• Rx, Ry, Rz — Reference point coordinates
• Ex, Ey, Ez — Eye point coordinates
• Cx, Cy, Cz — Component coordinates in 3D space before transformation
• Cxn, Cyn — Component coordinates in 2D space after transformation

October 2020
FMDNA Overview
Figure 30-5. 3D Representative Diagram

October 2020
FMDNA Overview
Figure 30-6. Deriving the X Coordinate for a Component
Considering Figure 30-6, you get the following equations:
(30-1)
(30-2)
From Equations 1 and 2, you get the following equation:
(30-3)
From Equation 3, you get the following equation:
(30-4)

October 2020
FMDNA Overview
From the above equation, you can derive the X coordinate of the component when it is
transformed from a 3D representation to a 2D representation, as shown above.
Now consider “Deriving the Y Coordinate for a Component” on page 652.
Figure 30-7. Deriving the Y Coordinate for a Component
You get the following equations:
(30-5)
(30-6)

October 2020
FMDNA Overview
From Equations 1 and 2, you get the following equation:
(30-7)
From Equation 7, you get the following equation:
(30-8)
From the above, you can see how you derive the Y coordinate of the component when it is
transformed from a 3D representation to a 2D representation, as shown above.

October 2020
FMDNA Files
FMDNA Files
The FMDNA file specifies the position of the components and how they are viewed in the
Network window.
Steps for building networks manually:
1. Access FMDNA.
2. Enter the login information and the network name.
3. Define the components and their position.
4. Define the nodes (for example, node type) and their position.
5. Define the links between the components and nodes.
6. Define the eye point location, which is the position of the network within the Network
Drawing window.
7. Execute the FMDNA function to create the network.
In practice, when building networks, you use a CAD package (such as CATIA) interface to
provides details about the components, nodes, connections etc into the Simcenter Flomaster
database to construct the network. But the following topics demonstrate the how to use the
Simcenter Flomaster provided tools to construct the simple network shown below.
Figure 30-8. Creating and Editing FMDNA Files - Example Network

October 2020
Saving the File and Executing the FMDNA Function
Saving the File and Executing the FMDNA

Function
After generating an FMDNA file, you must save the file before you can run it.
Procedure
1. Click OK to generate the FMDNA file.
2. Navigate to the folder where you want to store the FMDNA file, and click OK.
A confirmation dialog box opens.
Tip
Store your files in a sub-folder in the main Flomaster folder.
3. Run the Command Interpreter, Cmd.exe, to display the Command Interpreter window.
4. Type the cd command to change directories to the following path:
C:\Program Files (x86)\Simcenter\Flomaster>
5. Enter the following additional details:
FloMASTER.CommandLine FMDNA"C:\Documents and Settings\Username\
MyFMDNAFiles\MyFMDNAFile.fmdna"
6. Press the Return key to execute the command.
Any errors are reported in the errors file.
7. Open Simcenter Flomaster to confirm that the network was created.

October 2020
Adding Controllers and Gauges to a Network
Adding Controllers and Gauges to a Network

When adding a controller or gauge to an FMDNA network, you must edit the existing FMDNA
file and define signal links between the controller or the gauge. For controllers, there are two
signal paths to define: the input to the controller and the output to the controlled component. For
gauges, depending on how you want to use them, there may be only one connection, for
example, connecting a gauge to a node to measure the pressure.
Adding Signal Links for a Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Adding Gauges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Adding Controllers
When adding a controller to an FMDNA network, you must edit the existing FMDNA file and
define signal links between the controller. This example demonstrates how to add a Pump
Torque Feedback Controller to an existing network and then use it to control the pump torque.
Procedure
1. Choose Tools > New/Edit Command Line File.
2. Select the FMDNA option, and then click OK.
The Open dialog box opens.
3. Navigate to the location of the FMDNA file you want to edit, select it, and click OK to
open the file.
4. Click in the Components cell and open the Component Collection Editor dialog box.
5. Click the Add button and enter the controller details as shown in the following figure.

October 2020
Adding Signal Links for a Controller
Figure 30-9. Adding a Controller
Figure 30-10. Adding a Controller - Example Network
Related Topics

After adding the controller, define the signal links.

October 2020
Prerequisites
• Add a controller.
Procedure
1. Click in the Signal Links cell and open the Signal Link Collection Editor dialog box.
3. Enter the details for connection 1, the link between the MO output of the pump and the
MI connection of the controller, as shown in the following figure.
Figure 30-11. Adding Signal Links for a Controller
4. Enter the Link Information as shown in the following table.
Table 30-2. Adding Signal Links

Link Information Description
Feature Name of the output feature from the component, in this case
the Pump. In this example, this is set to Rotational Speed
Result, because the controller is used to control the torque of
the pump.
From Number of the component where the link starts, in this case,
2—the Pump.
FromArm In this example, set as shown in Figure 30-11, because the link
starts at the MO output of the pump rather than an arm.

October 2020
Table 30-2. Adding Signal Links (cont.)

FromIsNode Set to False because the link starts from a connection rather
than a node.
FromSignal Number of the connection from where the link starts, in this
case, connection 4 on the pump.
IsOrthogonal Determines the link type. If set to False, then the link is
straight.
To Number of the component where the link terminates, in this
case, 5—the Controller.
ToArm In this example, set as shown in Figure 30-11, because the link
terminates at the MI input to the controller rather than an arm.
ToIsNode Set to False, because the link is terminating at a connection
rather than a node.
ToSignal Number of the connection where the link terminates, in this
case, connection 1 of the controller.
5. Enter the details for connection 2, the link between the SO output on the controller to the
Torque input (Pin 2) as shown in the figure.

October 2020
Figure 30-12. Adding Controller Links
Table 30-3. Adding Controller Links

Feature In this case, this is blank. Having defined the input feature, the
software automatically knows which feature is required when
you make the connection to the Pump.
5—the Controller
FromArm In the example, set as shown. This is because the link starts at
the SO output of the Controller rather than an arm.
FromIsNode Set to False, because the link is starting from a connection
rather than a node.
case, connection 2 on the Controller.
IsOrthogonal Number of the connection from where the link starts, in this
case, connection 2 on the Controller.
To Number of the component where the link terminates, in this
case, 2—the Pump
ToArm In the example, set as shown. This is because the link
terminates at Pin 2, the Torque input on the Pump rather than
an arm.

October 2020
Adding Gauges
Table 30-3. Adding Controller Links (cont.)

ToIsNode Set to False, because the link is terminating at a connection
rather than a node.
ToSignal Number of the connection where the link terminates, in this
case, connection 2 on the Pump
6. Click OK to save the file.
7. Run the Command Interpreter, Cmd.exe, and rerun the FMDNA function to update the
network.
Related Topics
Adding Controllers
Adding Gauges
When adding a gauge to an FMDNA network, you must edit the existing FMDNA file and
define signal links. In this example, add a Gauge to your existing network to measure the Level
at Node 3.3.
Procedure
1. Choose Tools > New/Edit Command Line File.
2. Select the FMDNA and Edit Existing File options, and then click OK.
3. Navigate to the location of the FMDNA file you want to edit, select it, and click OK to
open the file.
4. Click in the Components cell and open the Component Collection Editor dialog box.
5. Click the Add button and enter the controller details as shown in the following figure.

October 2020
Adding Signal Links for a Gauge
Figure 30-13. Adding a Gauge
Figure 30-14. FMDNA - Adding a Gauge
Related Topics

After adding the gauge, define the signal links.

October 2020
Prerequisites
• Add a gauge.
Procedure
1. Click in the Signal Links cell and open the Signal Link Collection Editor.
2. Click the Add button and enter the details for the connection as shown in the figure.
Figure 30-15. Adding Signal Links for a Gauge
Table 30-4. Adding Signal Links

Feature Name of the output feature you want to measure, in this case,
Level.
6—the Gauge.
FromArm In the example, set as shown, because the link terminates at a
node rather than an arm.
FromIsNode Set to False, because the link is terminating at a node, in this
case, Node 3.
case, connection 1 on the Gauge.

October 2020
Table 30-4. Adding Signal Links (cont.)

straight.
To Number of the node where the link terminates, in this case,
Node 3.
ToArm Set as shown, because the link terminates at a node rather than
an arm.
ToIsNode Set to True, because the link is terminating at Node 3.
ToSignal Set as shown. because the link terminates at Node 3 rather
than a connection.
3. Click OK to save the file.
4. Run the Command Interpreter, Cmd.exe, and rerun the FMDNA function to update the
network.
Related Topics
Adding Gauges

October 2020
Using FMDNA to Create a Cavity
Using FMDNA to Create a Cavity

The process of creating a network containing a cavity component is similar to that of building a
standard network. But in the case of a network containing a cavity, the result is a network
containing a blank cavity; that is, there is no underlying network that defines the cells and
connections that make up the cavity.
Building the underlying network involves adding extra XML extensions to the basic FMDNA
file that describes all of the background detail for the cavity.
After adding the extra XML code, re-execute the FMDNA function from the command line to
add in the structure of the cavity. The process involves the following steps:
1. Enter the login information and the network name.

2. Define the non-cavity components and the cavity.
3. Define the nodes, node type (for example, Incompressible), and node position.
4. Define the links between the components and the nodes.
5. Define the eye point location, which is the position of the network within the Network
Drawing window.
6. Execute the FMDNA function to create basic network.
7. Add the XML extensions to the XML file to include the following details about the
cavity:
o Add details about the cavity outline.
o Define the face types (for example, Solid, Fluid, Rotating Smooth Face) and the start
and end points of each face.
o Define the cells that comprise the cavity and their associated face IDs.
o Define the external connections of the cavity.
8. Execute the FMDNA function again to create the structure for the cavity.
The basic network you will build is shown in the following figure.

October 2020
Creating Cavities
Figure 30-16. Creating a Cavity - Example Network
Figure 30-16shows the cavity that is created by adding the extra extensions to the XML file.
Creating Cavities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666

Creating Cavities
Create a network containing a cavity.
Prerequisites
• Enter all geometric data in strict SI units.
• The cavity structure must be explicitly defined, or the structure is inherited from a
relevant cavity in the appropriate catalogue.
Procedure
1. Access FMDNS. Refer to “Accessing FMDNA” on page 694.
2. Enter the project details as shown in Table 30-6 on page 694.
3. Define the components. Refer to “Defining Components” on page 691.

October 2020
Creating Cavities
Figure 30-17. Creating a Cavity - Defining Components - Example 1
a. Enter the details for Component 14, as shown in the following figure.

October 2020
Creating Cavities
b. Enter details for the other two source components by clicking the Add button and
entering the details shown in the following figures.

October 2020
Creating Cavities
a. Enter the details for the cavity by clicking the Add button and entering the details
shown in the following figure.
The cavity is defined by entering its Globally Unique Identifier (GUID), which in
this case is 2b6fd523-106a-4040-839f-1662a1b7ede7.
4. Define the nodes. Refer to “Defining Nodes” on page 688.

October 2020
Creating Cavities
Figure 30-22. Creating a Cavity - Defining Nodes - Example 1
a. Repeat the process for the remaining nodes, as shown in the following figures.

October 2020
Creating Cavities
5. Define the connections between the components and the nodes. Refer to “Defining
Connections Between Components and Nodes” on page 684.
Figure 30-25. Creating a Cavity - Defining Connections - Example 1

October 2020
Creating Cavities
a. Repeat the process for the remaining connections, as shown in the following figures.

October 2020
Creating Cavities

October 2020
Creating Cavities
6. Define the eye point location. Refer to “Defining the Eye Point Location” on page 688.
a. Enter the coordinates as follows:
o X=0
o Y=0
o Z=0
Setting the eye point location defines the overall position of the network within the
Network Drawing window. The position is expressed as a set of three-dimensional
Cartesian co-ordinates, as shown in the following figure.
Figure 30-31. Defining the Eye Point Location

October 2020
Adding Extensions to the FMDNA File
7. Save the file and execute the FMDNA function.

8. Add extensions to the FMDNA file. Refer to “Adding Extensions to the FMDNA File”
on page 675.
Results
You created a network containing a cavity component.
Related Topics

Creating a network containing a cavity requires adding extra XML extensions to the basic
FMDNA file, which describes all of the background detail for the cavity.
Procedure
1. Navigate to the location of the folder containing the FMDNA file, right-click the file,
and choose Choose Program.
The Open With dialog box is displayed.
2. Choose Notepad to display the XML file.
The contents of the file display, as shown in the following figure.

October 2020
Figure 30-32. FMDNA File
3. Add the opening tag for the new element called Cavity Components at the point shown
in Figure 30-32. This is followed by the opening tag for the Cavity Component element
that describes the cavity and the D sub-element that identifies the particular cavity.

October 2020
The closing tags for the Cavity Components and Cavity Component elements appear at
the end of the XML file.
4. Insert the element called Outline. which defines the outline for the cavity. It also starts
with an opening tag and closing tag: <Outline></Outline>
This element is inserted immediately after the ID element.
Between these tags are the sub-elements that describe the vertexes of the cavity. Again,
these have opening and closing tags: <Vertex></Vertex>
The XML code that describes the outline and the vertexes is shown in the following
outline:
Figure 30-33. FMDNA Outline XML File
5. Insert the sub-element called DefaultTypes, which defines the Face Type (for example,
Fluid Face, Solid Face). This also starts with an opening tag and closing tag:
<DefaultTypes></DefaultTypes>
The XML code that describes this sub-element is shown in the following figure.

October 2020
Figure 30-34. FMDNA Outline XML Sub-Element File
6. Insert the sub-element called Faces, which defines the face of each cell comprising the
cavity. This also starts with an opening tag and closing tag: <Faces></Faces>
Each face is identified with an opening and closing tag: <Face></Face>
Within these two tags are the following sub-elements:
• ID — Identifies the ID of each face, for example: <ID>1</ID>
• FaceType — FaceType — Identifies the face type by using its associated GUID, for
example:
<FaceType>5E4343E0-BFA9-45C5-827E-1812C1430A14</FaceType>
• StartPoint — Identifies the start point of the face by defining its X, Y, and Z
coordinates.
• EndPoint — Identifies the end point of the face by defining its X, Y, and Z
coordinates.

October 2020
The XML code that describes these face elements is as follows:

<Faces>
<Face>
<ID>2</ID>
<FaceType>5E4343E0-BFA9-45C5-827E-1812C1430A14</
FaceType>
<StartPoint>
<X>0.400</X>
<Y>0.100</Y>
<Z>0</Z>
</StartPoint>
<EndPoint>
<X>0.3</X>
<Y>0.100</Y>
<Z>0</Z>
</EndPoint>
</Face>
<Face>
<ID>3</ID>
FaceType>
<StartPoint>
<X>0.200</X>
<Y>0.100</Y>
<Z>0</Z>
</StartPoint>
<EndPoint>
<X>0.200</X>
<Y>0.250</Y>
<Z>0</Z>
</EndPoint>
</Face>
<Face>
<ID>4</ID>
FaceType>
<StartPoint>
<X>0.200</X>
<Y>0.250</Y>
<Z>0</Z>
</StartPoint>
<EndPoint>
<X>0.200</X>
<Y>0.400</Y>
<Z>0</Z>
</EndPoint>
</Face>
<Face>
<ID>5</ID>
FaceType>
<StartPoint>
<X>0.200</X>
<Y>0.400</Y>
<Z>0</Z>
</StartPoint>
<EndPoint>

October 2020
<X>0.400</X>
<Y>0.400</Y>
<Z>0</Z>
</EndPoint>
</Face>
<Face>
<ID>6</ID>
FaceType>
<StartPoint>
<X>0.400</X>
<Y>0.400</Y>
<Z>0</Z>
</StartPoint>
<EndPoint>
<X>0.400</X>
<Y>0.250</Y>
<Z>0</Z>
</EndPoint>
</Face>
<Face>
<ID>7</ID>
FaceType>
<StartPoint>
<X>0.400</X>
<Y>0.250</Y>
<Z>0</Z>
</StartPoint>
<EndPoint>
<X>0.400</X>
<Y>0.100</Y>
<Z>0</Z>
</EndPoint>
</Face>
<Face>
<ID>8</ID>
FaceType>
<StartPoint>
<X>0.400</X>
<Y>0.250</Y>
<Z>0</Z>
</StartPoint>
<EndPoint>
<X>0.3</X>
<Y>0.250</Y>
<Z>0</Z>
</EndPoint>
</Face>
<Face>
<ID>9</ID>
FaceType>
<StartPoint>
<X>0.3</X>
<Y>0.250</Y>
<Z>0</Z>

October 2020
</StartPoint>
<EndPoint>
<X>0.200</X>
<Y>0.250</Y>
<Z>0</Z>
</EndPoint>
</Face>
<Face>
<ID>10</ID>
FaceType>
<StartPoint>
<X>0.2</X>
<Y>0.1</Y>
<Z>0</Z>
</StartPoint>
<EndPoint>
<X>0.3</X>
<Y>0.1</Y>
<Z>0</Z>
</EndPoint>
</Face>
<Face>
<ID>11</ID>
FaceType>
<StartPoint>
<X>0.3</X>
<Y>0.25</Y>
<Z>0</Z>
</StartPoint>
<EndPoint>
<X>0.3</X>
<Y>0.1</Y>
<Z>0</Z>
</EndPoint>
</Face>
</Faces>
7. Insert the sub-element that describes the cells that make up the cavity: <Cells></Cells>
Each cell is identified by the following tags: <Cell></Cell>
• CellID — Identifies the ID of each cell, for example: <CellID>15</CellID>.
• FaceIDs — Between these tags is the sub-element FaceID, which defines the IDs of
each separate face, for example, <FaceID>5</FaceID>.

October 2020
The XML code that describes these cell elements is as follows:

Figure 30-35. FMDNA XML Code Cells Example
8. Insert the sub-element that describes the external connections to the cavity:
<ExternalConnections></ExternalConnections>
Each connection is identified by the following tags: <Connection></Connection>
• ArmNo — Identifies the particular arm of the cavity, for example, <ArmNo>1</
ArmNo>
• FaceID — Identifies the particular face of the cavity to which the arm is connected,
for example, <FaceID>2</FaceID>

October 2020
The XML code that describes these external connection elements is as follows:
Figure 30-36. FMDNA XML External Connections Example
9. Save the file, and execute the FMDNA function again to add the background detail for
the cavity.
10. To verity that the underlying network that comprises the cavity was created, right-click
the cavity symbol and choose Edit.
The Network window for the cavity opens. You should see the network cavity as shown
in the following figure.
Figure 30-37. Adding Extensions to the FMDNA File - Example Network

October 2020
Defining Connections Between Components and Nodes
Related Topics
Creating Cavities
Defining Connections Between Components

and Nodes
You can specify the number and type of connections between components and nodes.
Procedure
1. Click in the cell next to Links to reveal a button, and click the button.
The dmLink Collection Editor dialog box opens.
Figure 30-38. Defining Connections - Example 1
2. Click the Add button to add a connection, as shown in the following figure.
Note
Ensure that you enter the node name correctly.

October 2020
3. Enter the details for Connection 1 as described in the table.
Table 30-5. Defining Connections

Component Number of component, in this case 1.
FromArm Number of the arm from where the link starts, in this case,
Connection 1 on the pressure source.
straight.
LinkType Determines the link type (for example, Compressible,
Incompressible).
4. Repeat the process for the remaining connections, as shown in the following figures.

October 2020

October 2020

October 2020
Defining the Eye Point Location
Defining the Eye Point Location

Setting the eye point location defines the overall position of the network within the Network
Drawing window.
Procedure
Enter the coordinates for the eye point location as follows:
• X=1
• Y=1
• Z = 100
The position of the network is expressed as three-dimensional Cartesian coordinates, as
shown in the figure.
Defining Nodes
Simcenter Flomaster automatically creates a network diagram based on the components and
nodes you define.
Procedure
1. Click the cell next to Nodes to reveal a button. Click the button to display the Node
Collection Editor dialog box.
The Node Collection Editor dialog box opens.

October 2020
Defining Nodes
Figure 30-44. Defining Nodes - Example 1
2. Click the Add button to add a node, and then enter the Node Information for Node 1.
Note
Ensure that you enter the node name correctly.
3. Repeat the process of entering details for the remaining nodes, as shown in the following
figures.

October 2020
Defining Nodes

October 2020
Defining Components
Defining Components
Simcenter Flomaster automatically creates a network diagram based on a description of the
components you define.
Procedure
1. Click the cell next to Components to reveal a button.
2. Click the button to display the Component Collection Editor dialog box.
The Component Collection Editor dialog box opens.
3. Click the Add button to see the view in the following figure.
Figure 30-47. dmComponent Collection Editor Dialog Box - Example 1
4. Enter the details for Component 1, as shown in the following figure.

October 2020
Defining Components
Note
You must enter component names as they appear in their relevant catalogue. If you
do not, then an error is generated.
5. Click the Add button to enter the details for the other two components (not the pipe).

October 2020
Defining Components
6. For the Pipe, click in the adjacent cell to reveal a button. Click the button to display the
Pipe Collection Editor dialog box.
7. Click Add button to add the component, and then enter the details as shown below.

October 2020
Accessing FMDNA
Accessing FMDNA
To use FMDNA you must provide your file creation and project details.
Procedure
1. Choose Tools > New/Edit Command Line.
2. Select the FMDNA option, and then click OK.
The FMDNA File [ ] dialog box opens.
3. Enter the project details as shown in the following table.
Table 30-6. Login Details and Network Information

Field Description
Login Details
DataBase The name of the database you want to access.
DatabasePortNo Port number on which the database is hosted. The default is as
shown.
Note: This field is only applicable if you are using an
Oracle database.

October 2020
Accessing FMDNA
Table 30-6. Login Details and Network Information (cont.)

Field Description
Login Details
DatabaseType Type of database. The default is SQL.
DatabaseUserName Name assigned to you by your system administrator.
Note: If you are an administrator, you assign yourself a
name.
DatabaseUserPassword Password assigned to you by your system administrator.
password.
DataSource Location of the SQL database, which is one of the following:
• SQL Server 2008 Express that you run on your desktop
• Full SQL Server (for example, SQL Server 2008) that you
access from your network.
If you use SQL Server 2008 Express, enter the name as
follows:
localhost\SQLEXPRESS
If you use the full SQL Server, define the full pathname to the
database location.
LogonProject Name of the project you want to log in to.
Password Password assigned to you by your system administrator.
password.
RoleName Role assigned to you if you are using User Group Management
functions.
UserName Name you enter when you want to access Simcenter Flomaster
Network Information
Name Name of the network you want to create.

October 2020
Accessing FMDNA

October 2020
Chapter 31
FMU Export
Functional Mock-up Interface (FMI) is a standard which supports model exchange and co-
simulation of dynamic models using a combination of xml files and compiled C-code.
You can export Meta-Models in the FMI standard as a Functional Mock-up Unit (FMU).
• All output parameters are exported in the FMU and, for experiments which contain
Discrete Input Parameters, you have the option of exporting all possible permutations of
values or an individually selected permutation of values of the Discrete Input
Parameters.
• When imported into third-party, FMI compliant software, Discrete Parameters in
Simcenter Flomaster generated FMUs may not match those of the current simulation. In
this instance the nearest Discrete Value is used. In Simcenter Flomaster, for experiments
which contain Discrete Input Parameters, during FMU export a warning message to this
effect is displayed.
For Co-simulation applications, you can import an FMU that can then act as a controller and
provide output signals to the rest of the network.
Setting Up For FMU Exports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
Setting Up For FMU Exports

You must supply the location of a supported compiler, specify the files types, and specify the
location of the FMU SDK toolkit.
• You must be logged on to Simcenter Flowmaster as a Windows Authenticated user (See
“Creating User Logons” on page 752)
• You must have a Network Data Editor permission of level 3 or greater and Results
Creator set to Yes (See “Creating Permission Sets” on page 756 for details of permission
levels)
• FMU files contain information about the Simcenter Flomaster Database, project,
Network, and user details such as the user’s name and role. Because of this, it is unlikely
that an FMU file created on one machine will work on another.

October 2020
FMU Export
Setting Up For FMU Exports
It is recommended that you create FMU files on the machine where the co-simulation is
to take place but if this is not possible you must:
a. Unzip the FMU file
b. Edit the FmiFmConfiguration.json file's Database, LogonProject, UserName,
UserRole, WorkingProject, and NetworkName entries to match those on the co-
simulation machine.
Prerequisites
• Install a C/C++ compiler (the C/C++ compiler used in Visual Studio Express is
suitable).
• Install an FMU SDK toolkit (a suitable toolkit can be downloaded from https://fmi-
standard.org).
Procedure
1. Open the Options dialog box from Tools > Options.
2. Open the FMU Export tab.
3. Select the Create FMU file from exported source files check box.
Note
When exporting Meta-Models you may want Simcenter Flomaster to export the
source files to a directory for you to compile manually. To do this, ensure that the
Create FMU file from exported source files check box is not selected
4. Choose a compiler by:

a. Selecting one from the Supported Compiler Location dropdown list.
The Supported Compiler Location drop down will display the name and path of any
Visual Studio C/C++ installation installed on the machine.
b. If GCC 64 bit is selected, and you have an installed version of 64 Bit MinGW, click
Browse in the 64 Bit MinGW Location field and navigate to the 64 Bit MinGW
compiler.
Caution
The 64 Bit MinGW compiler is typically installed in the C:\Program Files\
mingw-w64\x86_64-8.1.0-win32-seh-rt_v6-rev0\mingw64 directory.
5. Specify the location of the FMU SDK by either:

a. Typing the path in to the FMU SDK Location field
b. Clicking the Browse button and navigating to the path that contains the SDK
6. Click Apply to save the changes and OK to close the Options dialog box.

October 2020
Chapter 32
Hydrodynamic Force Results Export
For certain Simcenter Flomaster components you can export the hydrodynamic force results.
Results can be exported in file formats compatible with several third party pipe stresses
modelling tools.
Exporting Hydrodynamic Force Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Exporting Hydrodynamic Force Results

Simcenter Flomaster contains a tool which you can use to export the hydrodynamic force data
for components that contain that result.
• Hydrodynamic force is reported for certain pipes, valves, and transition components.
For more information on the results available for components see Simcenter Flomaster
Components Reference Manual.
Prerequisites
• A network containing pipes, valves, or transitions and at least one set of compressible
simulation results.
Procedure
1. Select the Hydrodynamic Force Export option from the File > Exportmenu.
The Hydrodynamic Force Export dialog box opens.
2. Use the dropdown to specify an output format1.

Choose from:
• CAESAR II®
• CAEPIPE
• TRIFLEX®
• ROHR2
1. CAESAR II(R) is a registered trademark of Hexagon AB. CAEPIPE is a registered trademark of SST
Systems, Inc. TRIFLEX(R) is a registered trademark of PipingSolutions, Inc. ROHR2 SIGMA is a registered
trademark of Ingenieurgesellschaft mbH.

October 2020
Hydrodynamic Force Results Export
Exporting Hydrodynamic Force Results
When selecting ROHR2 you can also choose whether to export with or without mapping
information.
3. For Networks with multiple result sets you can use the Result dropdown to specify the
results to be exported.
4. Specify which component's results are to be exported. Use the Select Components
options to choose all components of a given type or choose individual components by
selecting them from the list in the lower area of the dialog box.
Note
The number of the component in the lower area of the dialog box relates to the
component’s number in the Network.
5. Click Export.
6. Navigate to the folder where you want to save the file, enter a name, and click the Save
button.

October 2020
Chapter 33
N-Arm Component
The N-Arm component functionality enables you to create multi-arm (up to 45 arms)
Simcenter Flomaster components based upon data derived from the 3D CFD package FloEFD,
or from user defined scripts which describe the required pressure response and thermal
behavior. Once defined, the components become part of the Simcenter Flomaster component
catalogue alongside the supplied components.
There are three types of N-Arm component:
• FloEFD N-Arm Component

Based on a FloEFD .flonarm file which enables you to use 3D CFD data to characterize
the performance of complex 3D shapes where the performance data does not currently
exist.
• FloEFD One Simulation N-Arm Component
One or more FloEFD hydrodynamic boundary conditions are nominated for linking to
the Simcenter Flomaster network. Once connected, a simulation instigated from within
Simcenter Flomaster will solve both the FloEFD model and the Simcenter Flomaster
network concurrently, until steady state or transient convergence. Flow rates, pressures,
and fluid temperatures are communicated through the linked boundary conditions/
hydraulic nodes during simulation.
• Scriptable N-Arm component
Based on you own calculations which enables you to define the pressure and thermal
performance of the component as a script, incorporating such algorithms or performance
maps as you have access to.
Note
You can create N-Arm components that have between 2 and 45 arms.
N-Arm Component - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702

Creating a Scriptable N-Arm Component. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
Creating an N-Arm Component using .floarm FloEFD Data . . . . . . . . . . . . . . . . . . . . . 704
Creating an N-Arm Component Using OneSim FloEFD Data . . . . . . . . . . . . . . . . . . . . 705
N-Arm Components: Restrictions and Conditions of Use of OneSim Components . . . 707
The N-Arm Component - GPL Tuning Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709

October 2020
N-Arm Component
N-Arm Component - Overview

The N-Arm component is a Simcenter Flomaster component with between 2 and 45 fluid arms
(user specified) and no input or output signals.
The specific behavior of an N-Arm component is determined by either the FloEFD
characterization data or a script.
Flow in the component has no transient inertia – the flow is steady state or quasi-steady and
mass flow is conserved across all arms.
The component is assumed to be at a level that is the average of its attached nodes. The effect of
gravity on the flow between each node and the corresponding arm at the component level is
taken into consideration.
Pressure
Arm 1 is the reference arm and the total pressures at all other arms are calculated from the
internal pressure drop within the component (provided by Script or FloEFD file) at each arm
relative the reference arm.
Enthalpy
If outflow enthalpy is not specified, perfect mixing is applied. Otherwise the outflow enthalpy is
specified by the component using either thermal characterization data (FloEFD N-Arm) or a
scripted enthalpy response.
For complex, two phase (vapor cycle) circuits the enthalpy is calculated using the fluid
properties. For incompressible or compressible simulations enthalpy is calculated using the
following equation:
Note
Enthalpy results for two-phase branch arms is total enthalpy.
For FloEFD N-Arm Components

FloEFD N-Arm components are not intended to operate in flows that are outside the
characterization range and, as a rule of thumb, you should ensure that the range of operation is
within 10% of either of the range width boundaries of characterization.
Simulations that approach the characterization boundaries will converge much slower than
those that are well within the range of characterization.

October 2020
N-Arm Component
Creating a Scriptable N-Arm Component
Simulations which use flows outside the characterization range will produce unreliable results
and Simulation Warnings will be issued.
Related Topics
Creating an N-Arm Component using .floarm FloEFD Data
Creating a Scriptable N-Arm Component

You can create new N-Arm components which use scripts that can incorporate any algorithms
or performance data that you choose.
Prerequisites
• You must have a license which permits the creation of N-Arm components.
• You must have Network Configurator permission.
Procedure
1. Select the Component group from the Launchpad.
2. Click the New Script Based N-Arm Component link.
The N-Arm Component Wizard opens.
3. Type a name for the component in the Component Name field.
4. Type a number of arms (between 2 and 45) in the Number_of_Arms field.
5. Click CREATE.
The component is created with a default script in the User-Defined Script Catalogue.
This script can be edited from the catalogue or by right clicking on the component in the
network.
Note
If you choose to edit the component in the network then the changes will propagate
to all other instances of the same component in that network.
Results
The Launchpad closes and Simcenter Flomaster opens with the Component Cutomisation Form
for the new N-Arm component open.
For information about further modifying the new component see “Customizing Components”
on page 268.

October 2020
N-Arm Component
Creating an N-Arm Component using .floarm FloEFD Data
Creating an N-Arm Component using .floarm

FloEFD Data
You can create new N-Arm components based upon a FloEFD .floarm file.
Prerequisites
• To create an N-Arm component from FloEFD data you must first create (and save in a
suitable loaciton) a .floarm file.
Procedure
2. Click the New FloEFD N-Arm Component link.
The N-Arm Component Wizard opens.
3. Click the SELECT N_ARM FILE ... button.
The Select FloEFD File dialog box opens.
4. Navigate to the location of your FloEFD (*.flonarm) file, select it and click Open.
The FloEFD file is loaded.
5. Click NEXT.
The FloEFD Import Summary screen is shown. From this screen you can:
• Review the FloEFD Branch, Hydraulic, and Thermal data.
• View a graphical representation of the N-Arm component. You can rotate, pan, and
zoom to change the view of the component.
Note
The Branch, hydraulic, thermal data, branch numbers and labels are read from the
FloEFD file and cannot be edited from the N-Arm Component Wizard.
6. You can create and attach a new component symbol by clicking the button.
Note
If you do not attach a symbol at this point the component will be created with a
default symbol, .

October 2020
N-Arm Component
Creating an N-Arm Component Using OneSim FloEFD Data
Simcenter Flomaster creates a symbol based on the current view of the component in the
wizard.
Results
The Launchpad closes and Simcenter Flomaster opens with the Component Cutomisation Form
for the new N-Arm component open.
For information about further modifying the new component see “Customizing Components”
on page 268.
Related Topics
Creating an N-Arm Component Using OneSim

FloEFD Data
You can create new N-Arm components based upon a FloEFD .onesim data file.
Prerequisites
• FloEFD model should be loaded, meshed and a preliminary solution performed in
FloEFD. The solution is not required by Simcenter Flomaster, but certain files created at
the start of the solution process are required. It is good practice however to ensure the
FloEFD model is well posed and solves without error when run ‘standalone’.
• You must first create (and save in a suitable loaciton) a .onesim file.
• The following components are not supported in Steady State OneSim models (but are
supported in Transient OneSim models):
o T and Y-Junctions
o The Vapour Cycle components - VC Fixed Orifice Tube, VC Variable orifice Valve,
VC Thermal Expansion Valve, VC Compressor: Positive-displacement.
o N-Arm and Controller components created by scripts.
Procedure
1. Select the Component group from the Launchpad and click the New FloEFD One
Simulation N-Arm Component link.
The N-Arm One Sim wizard opens.
2. Click the SELECT ONESIM FILE ... button.

October 2020
N-Arm Component
Creating an N-Arm Component Using OneSim FloEFD Data
The Select OneSimulation File dialog box opens

3. Navigate to the location of your FloEFD (.onesim) file, select it and click Open.
The FloEFD file is loaded and displayed in the N-Arm Component Wizard dialog box.
A graphical representation of the FloEFD component is displayed on the right-hand side
of the wizard dialog box.
Figure 33-1. The N-Arm Component Wizard Preview Pane
You can drag and drop the text labels to arrange them in this preview pane and use the
tools accross the top to rotate and scale the image.
You can capture an image from the preview pane by clicking the
The title bar of the perview pane indicates that a new component symbol has been
created and will be applied to the new Simcenter Flomaster component on creation

October 2020
N-Arm Component
N-Arm Components: Restrictions and Conditions of Use of OneSim Components
4. You must link one or more FloEFD boundary conditions to the Simcenter Flomaster
network. Each of these boundary conditions will be an arm on the Simcenter Flomaster
OneSim N-Arm component. To do this use the Link with Flomaster check boxes in the
Boundary Conditions Mapping screen to select the required arms.
5. You can select up to 20 FloEFD goals which will then be displayed as output signals on
the Simcenter Flomaster OneSim N-Arm component. To do this use the Expose as
Output Signal check boxes in the FloEFD Project Goals table.
6. Click CREATE.
Note
If you did not create a symbol in step 3 the component will be created with a default
symbol, .
N-Arm Components: Restrictions and

Conditions of Use of OneSim Components
There are some specific requirements and limitations when creating and using a FloEFD One
Simulation N-Arm Component.
The same, or very similar, fluid must be defined separately in FloEFD and the
Simcenter Flomaster Network.
Requirements of the FloEFD Data

The FloEFD model’s Units definition must be in SI units for the Goals, that are exposed in
Simcenter Flomaster, to be recognized.
Note
Any changes made to the FloEFD model after export of the .onesim file will not be
recognized by Simcenter Flomaster.
Requirements of the Simcenter Flomaster Network

The following simulation types only are supported by OneSim:
• 1.Incompressible Steady State

• 2.Heat Transfer Steady State
• 3.Incompressible Transient
• 4.Heat Transfer Transient

October 2020
N-Arm Component
N-Arm Components: Restrictions and Conditions of Use of OneSim Components
Note
Changing between steady state and transient solution options in Simcenter Flomaster would
require the same change to be made in FloEFD and the .onesim file to be re-exported and re-
imported.
You can only have one OneSim N-Arm component in each Network. The OneSim N-Arm
component must be part of one circuit only.
The circuit that contains the OneSim N-Arm component must also contain a pressure or flow
source.
The pressure or flow source, or a junction component, should not be connected directly to the
OneSim N-Arm component.
You can only connect one Simcenter Flomaster component to each arm on the OneSim N-Arm
component.
The FloEFD Project Location

When creating a OneSim N-Arm component in Simcenter Flomaster (for details see “Creating
an N-Arm Component Using OneSim FloEFD Data” on page 705) the resulting
Simcenter Flomaster component is linked to the FloEFD project's location at the time of
creation. You can change the location of the FloEFD project in the Simcenter Flomaster
OneSim N-Arm component by:
From the Network drawing window, right-click over the OneSim N-Arm component and
choose N-Arm Data from the menu. Edit the FloEFD project path in the FLOEFD PROJECT
field and click SAVE.
This is useful when unpacking a Simcenter Flomaster Network, which contains a OneSim N-
Arm component, on a machine other than the one that it was created on (and so the FloEFD path
is likely to be different).
During Simulation
When running a Transient simulation which contains a OneSim N-Arm component, the (fixed
constant) Time Step and Simulation End Time is used to apply the same settings to the FloEFD
model. This is regardless as to which time step or end time policy has been set in the FloEFD
model. The only requirement is that the FloEFD model must be set to be a Time-dependent
study.

October 2020
N-Arm Component
The N-Arm Component - GPL Tuning Parameters
The N-Arm Component - GPL Tuning

Parameters
The FloEFD and Scriptable N-Arm components use a pressure solver known as the
GPL (Gradient Perturbation Linearizer).
Note
The GPL solver is the same as that used in the T and Y Junction components. See the
Junctions chapter of the Simcenter Flomaster Component Reference Manual for more
information on using T and Y Junction components.
This solver has 3 tuning parameters that can be varied to change how it operates. However, in
practice it is extremely unusual that these should need to be changed.
• Perturbation Level
The algorithm probes the pressure response at the current mass flow. It then probes the
response in the region around this mass flow. The perturbation level defines how far to
perturb the mass flow when calculating pressure gradients.
For instance if the mass flow is ṁ perturbation mass flow is:
max(perturbationLevel · ǀṁǀ,minMassFlow)
Where:
minMassFlow is the convergence parameter. Reducing this parameter can increase
simulation speed but may reduce the robustness of the simulation.
Default = NOT SET (a value of 0.3 is used).
• Iteration Level
The algorithm is designed to limit how much the mass flow within the component will
change from iteration to iteration to increase the stability of the solution process.
The change in mass flow should be limited in each iteration to:
iterationLevel · ǀṁǀ
Increasing this parameter can increase simulation speed but may reduce the robustness
of the simulation.
Default = NOT SET (a value of 0.3 is used).
• Number of Points in Global Search
This value is not currently used.

October 2020
N-Arm Component
The N-Arm Component - GPL Tuning Parameters

October 2020
Chapter 34
3D CAD Import
Simcenter Flomaster contains tools to help you to import plant and piping data files.
• The Simcenter Flomaster 3D CAD Piping Import Tool is designed to be used to import:
o ISOGEN PCF files
o Intermediate Data Format IDF files
The files typically contain data derived from a CAD tool. The files define the positions
of the components that make up the plant or piping network. When this information is
imported, Simcenter Flomaster creates a network based on the connectivity information
in the file. The tool also contains two schemas, which allow imported components to be
mapped to their Simcenter Flomaster equivalents.
• The CAD to Simcenter Flomaster Sub-System import tool is designed to be used to
import .cad2fm files (typically created in the FloEFD™ product).
To use these tools, you need to purchase a special license.
3D CAD Piping Import Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712

3D CAD Import Tool Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
CAD to Simcenter Flomaster Sub-System Import Tool. . . . . . . . . . . . . . . . . . . . . . . . . . 723
Importing cad2fm Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723

October 2020
3D CAD Import
3D CAD Piping Import Tool
3D CAD Piping Import Tool

Use the 3D CAD Piping Import Tool when working with ISOGEN PCF and Intermediate Data
Format IDF files.
3D CAD Import Tool Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713

October 2020
3D CAD Import
3D CAD Import Tool Dialog Box
3D CAD Import Tool Dialog Box

To access: Tools > Import Tools > 3D CAD Piping Import Tool
Use this dialog box to import plant and piping data files into Simcenter Flomaster.
Description
The 3D CAD Piping Import Tool dialog box has three panes.
• The top-left pane lets you select the file and variables.
• the bottom-left pane shows a mirror view of the networks on your system. You can
create a new network from here.
• The right-hand pane shows a tree structure of the imported file.
Objects
Objects Description
Select File Selects the file to import into Simcenter Flomaster

October 2020
3D CAD Import
3D CAD Tool Mapping Schemas
Objects Description
Mapping Schemas Selects the required default mapping schema and access the
schema maintenance dialog box
• Incompressible Default Mapping Schema
• Compressible Default Mapping Schema
Isometric Orientation Sets the required isometric projection
Circuit Type Selects the circuit type
Read File Displays the contents of the file in the right-hand pane of the
3D CAD Piping Import Tool dialog box
Schema Maintenance
Connectivity Tolerance Selects the connectivity tolerance in MM
Variables Sets the global variables
3D CAD Tool Mapping Schemas

The mapping schemas act as templates. They check that an imported component, such as a
BEND or PIPE, is mapped to a suitable Simcenter Flomaster component.
There are two supplied schemas:
• Incompressible Default Mapping Schema

• Compressible Default Mapping Schema
Missing Components
If any imported CAD components are missing, or components are missing from the mapping
schema, then the components on either side of them are linked.
Unmapped Components
Components such as Flanges and Gaskets are ignored. In some cases, depending on the
component being imported, there may be an instance where a particular component, such as an
OLET or TEE-SET, has no defined mapping.
An undefined component mapping causes an error during the import process. To see which
components are causing problems, click the plus sign (+) next to a component to expand the
tree, as shown in the following figure.

October 2020
3D CAD Import
Importing a 3D CAD File
Figure 34-1. Unmapped Component Errors
To correct unmapped component errors, create a new schema, add the details of the component
to the schema, and map it to a suitable Simcenter Flomaster component, such as a Discrete Loss.

The 3D CAD files define the positions of the components that make up the plant or piping
network. When this information is imported, Simcenter Flomaster creates a network based on
the connectivity information in the file.

October 2020
3D CAD Import
Figure 34-2. 3D CAD Import Process
Procedure
1. Choose Tools > Import Tools > 3D CAD Piping Import Tool to open the 3D CAD
Piping Import Tool dialog box.
2. Click the Select File button.

October 2020
3D CAD Import
3. Navigate to the folder where the PCF or IDF files are stored, and select the required file.
4. If you need to set an alternative schema, such as the Compressible Default Mapping
Schema, click the Mapping Schemas dropdown list to choose it.
5. Click the Read File button to display the contents of the file in the right-hand pane of
the 3D CAD Piping Import Tool dialog box.
If any material information relating to pipes is missing from the PCF or IDF file, a
message displays showing which pipe schedule is being used.
Figure 34-3. Materials Dialog Box
6. Set the Global Variables by entering the required values.

7. Click the Isometric Orientation button to set the projection view.
The Isometric Orientation dialog box is displayed.
8. Select the required orientation and click OK.

9. Create a network.

October 2020
3D CAD Import
Creating Schemas
a. Right-click in the bottom pane of the 3D CAD Piping Import Tool dialog box, and
click New Network to create a new network.
b. To rename the network, right-click on it and choose Rename Network, and type in
the new name.
c. Click the Create Network button.
A confirmation message is displayed, and the network is added to the owning
project.
Note
If the file you are importing contains unmapped components, an error message
displays. Refer to “3D CAD Tool Mapping Schemas” on page 714.
d. Click Yes.
Any components displayed under the “Important to Connectivity” heading are likely to
prevent the creation of the network. A missing component (in this case the OLET)
leaves a gap or a loose pipe in the network. In such cases, create a new schema and add
these components.
10. When you have finished, click the Close button.
Creating Schemas
Creating a new schema enables you to add additional CAD components to a copy of a
Simcenter Flomaster schema, and map these components to a Simcenter Flomaster component,
such as a Discrete Loss.
The following process of creating a schema is based on one of the Simcenter Flomaster default
schemas: the Incompressible Default Mapping Schema.

October 2020
3D CAD Import
Creating Schemas
Procedure
1. Choose Tools > 3D CAD Piping Import Tool.
The 3D CAD Piping Import Tool dialog box is displayed.
2. Click the Schema Maintenance button.
The Incompressible Default Mapping Schema dialog box opens.
3. Click the New button.

October 2020
3D CAD Import
Creating Schemas
The Maintain Mapping Schema dialog box opens.
4. Type the name of the new schema, for example, My New Incompressible Schema.
5. The default circuit type is Incompressible. If you need to set the Compressible circuit
type, select it from the dropdown list.
6. Select the “Based on existing schema” option and then click the Create button.

October 2020
3D CAD Import
Creating Schemas
The My New Schema dialog box opens.
7. To add a component, go to the empty field in the Imported Components column and
select the required component from the dropdown list, such as TRAP-OFFSET, as
shown in the figure.
8. In the Simcenter Flomaster Components column, go to the empty field and select the
required component from the dropdown list.
9. If the component you added is a User Defined component, then continue as follows:
a. Enter the Name of the component and the No. of Arms, and click the Add button.
Entering the number of arms allows Simcenter Flomaster to filter the components
that are displayed when you click the associated dropdown list.

October 2020
3D CAD Import
Editing and Deleting Schemas
b. To set the required Pipe Standard, choose an option from the

Simcenter Flomaster Component dropdown list.
c. To set the Schedule No., choose an option from the Simcenter Flomaster Component
dropdown list.
10. When you have finished, click OK.
The schema is added to the list displayed in the 3D CAD Piping Import Tool dialog box.
Related Topics

You can edit or delete a schema that you have created.
You cannot delete or edit a Simcenter Flomaster schema. You can only perform these actions
for schemas that you have created.
Procedure
1. Choose Tools > 3D CAD Piping Import Tool.
The 3D CAD Piping Import Tool dialog box opens.
2. Click the Mapping Schemas dropdown list and choose an option, for example, My New
Schema.
3. Click the Schema Maintenance button.
The Schema Maintenance dialog box opens.
4. To edit the schema, click the associated button to display the Edit dialog box. Make the
changes and click OK.
5. To delete the schema, click the associated button. A confirmation is displayed. Click
Yes to confirm the deletion.
Related Topics
Creating Schemas

October 2020
3D CAD Import
CAD to Simcenter Flomaster Sub-System Import Tool
CAD to Simcenter Flomaster Sub-System

Import Tool
The CAD to Simcenter Flomaster Sub-System import tool is designed to be used to import
cad2fm files (typically created in the FloEFD™ product).
Importing cad2fm Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
Importing cad2fm Files

Importing a cad2fm file as a Sub-System.
Sub-Systems created by this method will contain only the following components:
• Pipe: Cylindrical
• Bend: Circular
• Bend: Circular Mitre
• T-Junction
• Y-Junction
Prerequisites
• You must have a Simcenter Flomaster license that allows cad2fm file import.
Note
This procedure documents only the Simcenter Flomaster steps required to import cad2fm
files. For information on the creation of cad2fm files please see the user documentation for
your FloEFD installation.
Procedure
1. From the Launchpad, choose the Sub-System option and click
New CAD to Flomaster Sub-System to open the Sub-System Import Wizard.
2. Click the SELECT CAD TO FM FILE... button to open a browse dialog box.
3. Navigate to the cad2fm file that you want to import and click Open to select it.
The Sub-System is imported.
4. Click NEXT.
A graphical representation of the Sub-System (with a discretized centreline and the x, y,
and z planes) is shown in the the wizard.

October 2020
3D CAD Import
Figure 34-4. Importing cad2fm Files
5. Use the SUB-SYSTEM CONNECTION TYPE dropdown menu to specify the

connection type. Choose from Compressible or Incompressible.
6. Use the SUB-SYSTEM SCHEMATIC VIEW dropdown menu to specify either:
• Avoid Overlapping Nodes - In the resulting sub-system, the components are moved
away from each other to ensure all connection nodes are visible.
• Maintain 3D Projection - The resulting sub-system adheres to the view in the 3D
window, but this may result in overlapping connection nodes.
7. Specify the Roughness and Wave Speed values.
8. You can specify the direction of gravity. In this instance, the imported sub-system will
have a level value for each hydraulic node, based upon the original coordinate location
and the specified gravity direction. In this way you can model hydrostatic effects.
Use the GRAVITY DIRECTION dropdown list to choose an option.
• Use X,Y,Z Coordinates
The imported sub-system will not include hydraulic node level data. The imported
sub system nodes' X,Y,Z coordinates data will be set and the sub system will be
oriented as displayed in the Import Wizard preview.

October 2020
3D CAD Import
• +X, -X, +Y, -Y, +Z, -Z

The imported sub-system will include hydraulic node level data and will be
orientated according to the direction of gravity (unless you use the Pan tool to
reorientate or resize, as described in step 9).
Note
Using the GRAVITY DIRECTION field means that the import wizard will
orientate the sub-system so that gravity is acting in the direction specified. For
example, specifying gravity as -Z will orientate the sub-system so that the Z(+) axis is
up.
9. Use the Move, Pan, Tilt, and Zoom tools to orientate the sub system into a view that is
suitable for your Simcenter Flomaster Network.
Note
The size of the component symbols in the Simcenter Flomaster Sub-System are
dictated by the zoom settings you choose at this point - The more the view is zoomed
in, the smaller the component symbols will be after import.
10. Click the IMPORT button.

The Sub-Sytem opens in Simcenter Flomaster and is saved in Catalogues > Sub-
Systems > User-defined with a name matching that of the cad2fm file.
You can review and edit any of the parameters for the components, just as you would for
any other Simcenter Flomaster Sub-System or Network.
Note
Rounding of the numerical values of geometric parameters is usual.

October 2020
3D CAD Import

October 2020
Chapter 35
MotorSolve File Import
You can create Simcenter Flomaster components from MotorSolve data.

MotorSolve is typically used to characterize electric motors used in the transport industry.
Creating a Simcenter Flomaster Component from a MotorSolve file . . . . . . . . . . . . . . 727
Creating a Simcenter Flomaster Component

from a MotorSolve file
You can create a Simcenter Flomaster component from a MotorSolve .msfm file.
Prerequisites
• You must have a license which permits the creation of MotorSolve based components.
• You must have a suitable .msfm file.
Procedure
2. Click the New MotorSolve Component link.
The MotorSolve Import dialog box opens.
3. Click the SELECT MOTORSOLVE FILE... button.
The Select MotorSolve File dialog box opens.
4. Navigate to the location of your *.msfm file, select it and click Open.
The MotorSolve file is loaded.

October 2020
MotorSolve File Import
Creating a Simcenter Flomaster Component from a MotorSolve file
Figure 35-1. The MotorSolve Import Dialog Box
5. You can modify the Name field (this will become the name of the new component) but
all other fields are read only.
6. Click the CREATE Button.
The MotorSolve Import dialog boxcloses and Simcenter Flomaster switches to the
Network Drawing window view.
The Catalogues Tab is open and the new component is selected (In the
Components > User-defined folder).
The Component Customisation Form, containing the details of the new component, is
displayed.
You can view the imported Loss Map surfaces and make modifications to the new
component. See “Customizing Components” on page 268.
Results
The new component can be used in any suitable network.

October 2020
Chapter 36
Pipe Schedule Wizard
Simcenter Flomaster contains a Pipe Schedule Wizard designed to help you to define a standard
range of pipes for a given application.
The wizard allows you define Simcenter Flomaster cylindrical pipes based on industry
standards, which you can then use when importing piping schedules (from, for example, a 3D
CAD package).
The following standards are supported:
• ANSI/ASME B36.10M and API 5L for general steel pipes

• ANSI/ASME B36.19M for stainless steel pipes
• DIN 2460 Butt Weld Joint
• DIN 2460 Butt Weld Joint-Seamless Pipe
• DIN 2460 Cut or Groove Pipe
• DIN 2460 Slip Weld Joint
• DIN 2460 Socket Joint
• DIN 2470
• JIS G 3459
You can also use the wizard to create your own pipe schedule standards.
Note
You can only use cylindrical pipes from the Pipes: Cylindrical and Pipes: Compressible
catalogs.
Using the Pipe Schedule Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729

Importing a New Pipe Schedule Standard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Managing Pipe Schedule Standards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Using the Pipe Schedule Wizard

You can use the Pipe Schedule Wizard to update pipe components to pre-defined standards.

October 2020
Using the Pipe Schedule Wizard
Prerequisites
• Add the pipe components to a collection. For more information on collections see
“Using the Collection List” on page 118.
Procedure
1. Select one of the pipes, and then click in either the Length or Diameter fields to display
the Pipe Schedule Wizard button, .
Tip
When using the wizard, it is sometimes useful to view the Pipe Standard Data sets.
You can do this at any time by clicking the Pipe Data button.
The Pipe Schedule Wizard opens. The pipes in the collection are displayed in the
wizard’s pipes table. The component number is shown in the User ID field.
2. Use the Standard Dropdown to pick a pipe standard.
3. Specify the Material Type by choosing a material from the dropdown menu.
The materials available will depend upon your selection in step 2.
You can duplicate the the material to some or all of the other pipes by right clicking over
the Material cell and then choosing either:
• Duplicate value to all rows - to set all pipes with the same material.
• Duplicate value to selected pipes, specifying the pipe numbers to populate in the
Specify Pipe Numbers dialog (see below), and then clicking OK
4. Complete the required data entries.

As with the step 3 (Material Type), you can use the right-clickmenu to populate your
values to other pipes.
The fields available in the pipe table section of the wizard are determined by your choice
of Standard in step 2.
The ANSI and JIS standards contain a field called Schedule - This is the number
associated with a particular pipe. When you set this the Inner Diameter and
Wall Thickness values are automatically populated.

October 2020
Importing a New Pipe Schedule Standard
For networks created using the 3D CAD tool or the GIS Import tool, Roughness and
Length values may already be set (depending on the imported data).
5. Click Finish to update the pipe data and close the wizard.

You can create your own Pipe Schedue Standards.
Prerequisites
• Files to be imported must be either an Excel Comma Delimited (.csv) file or Tab
Delimited (.txt) file.
An example of a tab delimited file is shown below:
Figure 36-1. Importing a New Pipe Schedule Standard - Tab Delimited Example
Note that:
o The first line specifies the units, which can be either inches (in) or millimetres (mm).
So, to enter the units in mm, you would enter 'Unit mm' as shown in the example. If
the standard being entered is in German, then the letters 'PN' have to be entered after
the unit. For example, 'Unit mm PN', where 'PN' is the 'Nominal Pressure'.
o DN, NPS (Nominal Pipe Size) are optional but you must specify one of them.
o Outer Diameter is mandatory.
o All column headers are case sensitive.
o All data must be entered in the manner shown in the example.
o In the example shown above, the columns from STD onwards relate to schedule data
and are optional. Depending on the imported data, then these columns may or may
not be present.

October 2020
Procedure
1. Click the button to display the New Standard dialog box.
2. Import the data by clicking the Import Data button and using the Open dialog box to
navigate to your file.
3. Enter a name for the new standard in Standard Name field.

October 2020
Managing Pipe Schedule Standards
4. Associate a material with the new standard by clicking the Add Material button and
picking a material from the Select Material dialog box.
Note
You can select multiple materials by using the Ctrl key.
5. Click Save to complete the set up of the schedule.

You can specify which pipe standard is the default and edit or delete imported (non-
Simcenter Flomaster provided) standards.
Procedure
From the Pipe Schedule Wizard click Pipe Data to open the Pipe Standard Data dialog box.
To set a standard as default:

a. Use the Standard dropdown to select the standard.
b. Click the button.
To edit an imported standard:

The Edit Standard dialog box opens.

c. Make the required edits and click OK to save and close.

October 2020
To delete an imported standard:


October 2020
Chapter 37
Vapor Cycle Components and Waste Heat
Recovery
Simcenter Flomaster contains components and functionality which help you in modeling the
recovery of a system’s energy that would otherwise be lost to the environment. Waste Heat
Recovery (WHR) modeling is useful for vehicle or small scale power station networks.
Note
To access the vapor cycle components and functions you will need a vapor cycle/waste heat
recovery enabled Simcenter Flomaster license.
The Simcenter Flomaster waste heat recovery tools allow you to use NIST REFPROP curves
and surfaces and model entire Organic Rankine Cycle (ORC) systems. There are a range of
Vapor Cycle components that you can use in your networks to allow you to perform “what-if”
scenarios.
The Vapor cycle components are contained in the Vapor Cycle catalogue which contains
evaporator, condenser, and expander components and the VC Circuit manager component.
You can view the results of waste heat recovery simulations by using thermodynamic diagrams
(temperature v entropy and pressure v enthalpy) which allow you to perform pinch point
analysis (these show how well the current system is performing compared to the theoretical
thermodynamic limits of the system - smaller pinch points are indicative of a higher
performance system).
Key to modeling networks where waste heat recovery is a factor is the VC Circuit Manager
component. This component enables you to carry out common Organic Rankine Cycle
optimization work-flows in a single simulation without the need to set up a parametric
experiment (see “Experiments” on page 465 for information on experiments).
The steps to running a simulation to investigate waste heat recovery are:
1. Create the network - You should ensure that your waste heat recovery networks contain
the appropriate vapor cycle (VC) components. For information on suitable components
for waste heat recovery modeling see The Vapor Cycle Components, for information on
creating Simcenter Flomaster networks see Modeling Networks.
2. Set the input data for the components.
3. Specify the fluid type - you can use one of the Simcenter Flomaster NIST REFPROP
fluids or create your own (see NIST REFPROP).

October 2020
Vapor Cycle Components and Waste Heat Recovery
The Vapor Cycle Components
4. Run the simulation (as a Two Phase Steady State simulation type)
5. Review the results.
The Vapor Cycle Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
Using The VC Circuit Manager Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Plotting The Results Of Waste Heat Recovery Simulations . . . . . . . . . . . . . . . . . . . . . . 741
Using Multiple Speed Controlled Components in Waste Heat Recovery Simulations . 742
Using VC Turbine Components in Waste Heat Recovery Simulations . . . . . . . . . . . . . 744
Using VCSOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745

Only the components included in the Vapor Cycle catalogue have been specifically developed
and tested for use in the working fluid circuit of Organic Rankine Cycle/Waste Heat Recovery
networks. 'Complex 2-phase' circuit type components found outside of the VC catalogue may
adversely affect Organic Rankine Cycle/Waste Heat Recovery network functionality or may
simply be inappropriate in their functionality
The following components have been specifically designed for waste heat recovery
applications:
• VC 2-Port Valve
• VC 3-Port Valve
• VC 4-Port Valve
• VC Circuit Manager
• VC Condenser: Plate Frame
• VC Condenser: Shell & Tube
• VC Condenser: Tube & Fin
• VC Evaporator: Plate Frame
• VC Evaporator: Shell & Tube
• VC Evaporator: Tube & Fin
• VC Pipe
• VC Pump: Positive Displacement - Data Based
• VC Recuperator: Plate Frame
• VC Expander: Data-based

October 2020
• Heat-Exchanger: Heater - Cooler

• Pump: Radial Flow
Additional to the above components, you may use the components listed in Table 37-1 with
caution. These components have not been designed to be used in waste heat recovery network
but, with care, can provide useful functionality. Table 37-2 lists the components that you should
not use in waste heat recovery networks.
Table 37-1. Non-vapor Cycle Components Suitable for Waste Heat Recovery
Applications
Type Component Notes
Bends • Circular You should specify your
• Circular Composite Mitre own loss coefficient curve.
• Circular Mitre
• Rectangular (Aspect Ratio 0.5)
• Rectangular Composite Mitre
• Rectangular Mitre
Loss Cd Discrete Loss
Diaphragm Diaphragm: Bursting Disc
Volume Fixed Volume
Hose Flexible
Loss • Discrete
• Discrete with Patterns
Orifice • Long: Compressible The Loss Coefficient and
• Sharp-edged (Conical) Correction Factor curves for
these components are not
• Sharp-edged (Standard Orifice Plate)
designed for transitional
• Short: Compressible fluids or vapors.
Source • Blank End (Zero Flow) You are strongly advised to
• Flow use the VC Circuit Manager
component in place of a
• Pressure
source component.
• Pressure v Flow
Transition • Abrupt You should specify the
• Gradual Contraction Loss
Coefficient

October 2020
Table 37-1. Non-vapor Cycle Components Suitable for Waste Heat Recovery
Applications (cont.)
Valve • Y Butterfly Types B and C
• Angle may be unreliable for vapor
at openings of less than 0.3
• Ball
• Butterfly (Types A, B, and C)
• Diaphragm (Full and Reduced Bore)
• Gate (Seat Area = Pipe Area)
• Globe
• Sluice (Seat Area = Pipe Area)
Compressible Check This is the only check valve
that should be used in vapor
cycle networks.
Table 37-2. Components Not Suitable for Waste Heat Recovery Applications
Accumulator • Air Vessel
• Bladder - Fixed Geometry
• Bladder - Variable Geometry
• Gas
• Vented Air Vessel
Valve • Cd Valve
• Cd Valve + Valve Dynamics
Generic • Generic Component Temperature results will be
incorrect.
Junction • T (30°, 45°, 60°, and 90 Unstable and non-
• Y (A1 + A2 = A3) convergent.
• Y (A1 = A2 = A3)
Orifice • Long Loss Coefficient and
• Radiussed Correction Factor curves not
designed for transitional
• Short: Fixed Throttle (60 L/min at 50
fluids or vapors.
bar)
• Short: Pressure Relief Valve (100 L/
min Rated Flow)
• Short: Variable Throttle (90 L/min at
120 bar)
• Square

October 2020
Passage Annular
Pipe • Compressible Rigid Use the VC Pipe component
• Cylindrical Compliant, Compliant Gas, instead.
Elastic, Elastic Gas, Gas, Rigid
• Hexagonal Bubbly, Compliant, Elastic,
Rigid
• Isothermal Cylindrical Gas
• Prismatic Bubbly, Compliant, Elastic,
Rigid
• Rectangular Compliant, Elastic, Rigid
• Two Phase: Separated Fluid
Two Phase Flow Pipe Use the VC Pipe component
instead.
Pump • Axial Flow Choose a pump type from
• Gear (Fixed Displacement & Variable the VC catalogue instead.
Speed)
• Mixed Flow
• Oil Pump
• Piston (Variable Displacement &
Speed)
• Positive Displacement - Data-based
• Radial Flow
• Surface Data
• Vane (Reversible Displacement &
Variable Speed)
• Water Pump
Reservoir • 2-arm Cannot be connected to
• 3-arm complex two phase.
• Blowdown Tank
• Bootstrap
• Constant Head
• Expansion Tank or Degas Bottle
• Finite Area
• Storage Vessel
• Variable Head
Source • Flow with Swirl Input Use VC Circuit Manager
• Pressure with Swirl Input instead.

October 2020
Using The VC Circuit Manager Component
Valve • Butterfly (Blakeborough) Unreliable results.
• Clapper Check
• Gas Admission/Release
• Pilot Check (180 L/min at 50 bar)
• Poppet Check
• Poppet Relief
• Simple Check (80 L/min at 6 bar)
• Simple Relief (Crack 240 bar;
Maximum 260 bar)
• Spring-operated Check (D1b125 5.0 N
Crack)
• Swing Check
• Waste Gate
Related Topics

Key to modeling networks where waste heat recovery is a factor is the VC Circuit Manager
component. This component enables you to carry out common Organic Rankine Cycle
optimization work-flows in a single simulation without the need to set up a parametric
experiment.
It is not recommended that you use the VC Circuit Manager component as a two phase pressure
source instead use a pressure source component in an open loop circuit to set the boundary
conditions.
Note
The VC circuit manager component should only be used for result reporting in an open loop
circuit.
It is good practice, when using the VC Circuit Manager component for result reporting only, to
filter out irrelevant results. For example, when collecting the Output Power, if the number of
VapourCyclePowerProvider is 0, the System Thermal Efficiency and Output Power results are
irrelevant.
Related Topics

October 2020
Plotting The Results Of Waste Heat Recovery Simulations
Plotting The Results Of Waste Heat Recovery

Simulations
You can view Temperature v Entropy and Pressure v Enthalpy thermodynamic diagrams for
waste heat recovery simulations. These diagrams indicate saturation envelopes, temperature
limits, and pinch points of the network.
• To access the waste heat recovery components and functions you must have a waste heat
recovery enabled Simcenter Flomaster license.
Prerequisites
• An open waste heat recovery network with simulation results.
Procedure
1. Open the Result Sets/Audit tab and select the results set that you want to use to create
the plots.
2. Click the Thermodynamic Diagram button, .
The Thermodynamic Diagram Options dialog box opens.

3. Select the range of components that you want to plot. Select either:
• Auto - to plot the entire cycle
• Collection Box - to plot only the components in the active collection (for more
information on using collections see Using the Collection List).
4. You can specify whether to include labels (the node and component numbers) and the
temperature limit lines by selecting the Labels and Temperature Limit options.
5. Select the appropriate fluid from the Saturation Line Display section.
6. Select the diagram type (Temperature Entropy (T-S) or Pressure Enthalpy (P-h).
7. Click OK.
Results
The thermodynamic diagram is displayed in a new window.
You can export, save and print thermodynamic plots (see Printing and Customizing Plots and
Network Diagrams).

October 2020
Using Multiple Speed Controlled Components in Waste Heat Recovery Simulations
Using Multiple Speed Controlled Components

in Waste Heat Recovery Simulations
When using two independent speed-controlled PD machines in Waste Heat Recovery
Simulations you must ensure that the mass flow through each machine is the same
Waste Heat recovery simulations often contain more than one speed-controlled component,
commonly the VC Expander: Data-Based and a pump component such as the
Pump: Positive Displacement. This can lead to convergence failures due to discrepancies in
mass flow through the two speed-controlled components.
Where possible, it is preferable to control the load Torque rather than the Speed of the Expander
(either with a constant value or a function where load varies with Speed). Where this is not
compatible with available data or system design consider the notes below when setting
Expander Speed.

October 2020
Using Multiple Speed Controlled Components in Waste Heat Recovery Simulations
Figure 37-1. Using Multiple Speed Controlled Components in Waste Heat

Recovery Simulations - Mass Flow Versus Pressure Drop
If the Pump Speed is fixed (as shown in Figure 37-1), there is a limited range of Expander
Speeds that will give a solution. You may estimate this range from the given performance data
or by performing a Parametric Study (“Parametric Studies Experiments” on page 469).

October 2020
Using VC Turbine Components in Waste Heat Recovery Simulations
Various outcomes are illustrated in the example above for three Expander Speeds:
1. If the Expander runs at medium speed, the system will operate at point A, which is
within the range of both the Expander data and of the Pump data.
2. If the Expander runs at low speed, the system will operate at point B, which is within the
range of the Expander data but extrapolates the Pump data and will produce a warning in
the results.
3. If the Expander runs at high speed, the simulation will halt with an error, because the
intersection point would be outside the range of the Expander data - in the case shown,
the intersection would be at negative Pressure Difference so the solution would not
converge.
4. If the Expander were running at a speed slightly nearer to the medium speed than the
high speed, the system would operate in the same way as Case 2.
5. If the Expander were running at a speed nearer the high speed or much lower than the
low speed, it might converge but the simulation will halt with an error, because the
intersection point would be outside the range of the Expander data.
Using VC Turbine Components in Waste Heat

Recovery Simulations
Stability problems may occur with the VC Turbine if the High-side Pressure is fixed.
If the High-side Pressure is too low for the given Design Point and Pump Speed, the maximum
Turbine Flow may be lower than the Pump Flow at any Pressure Difference and the solution
will not converge.
With a higher High-side Pressure or lower Pump Flow (due to lower Pump Speed for the same
Performance Data) there may be two intersection points, one of which is unstable and may
prevent convergence of the system to the correct point as well as attempting to impose a
negative Low-side Pressure.
However, a further increase in High-side Pressure or reduction in Pump Flow may put the
second operating point so far out of reach that the system converges stably.
Note
It is generally preferable to fix or control the Low-side Pressure, which is often the case, as
when the Condenser Outlet Pressure is controlled.

October 2020
Using VCSOP
Using VCSOP
The Vapor Cycle Shape Factor Optimization Program (VCSOP) is an optimization program that
automatically calculates tuning parameters (shape factors) that match the performance of VC
Condenser: Tube & Fin and VC Evaporator: Tube & Fin components, when used in
Simcenter Flomaster Vapor Cycle simulations.
VC Condenser: Tube & Fin and VC Evaporator: Tube & Fin components require shape factor
input data in order to be modeled correctly in a VC system.
Prerequisites
• A VC Enabled Simcenter Flomaster license.
• A Vapor Cycle network, containing a VC Condenser: Tube & Fin and VC Evaporator:
Tube & Fin component (or both) open in the Network Drawing window.
Procedure
1. Select VCSOP... from the Tools menu.
The Shape Factor Optimization Wizard opens.
2. Specify a % Scenario Optimization Tolerance value.
This value is used by the wizard to compare the target and actual simulation results for a
given set of shape factors and asses whether a scenario is converged or not. The larger
the value the further from target simulation results can be for a converged simulation.
3. Specify a Maximum Number of Steps.
This is the maximum number of iterations that the wizard will run.
Note
A step is classed as the adjustment of each shape factor (Heat Transfer Shape Factor
for path 1-2, Pressure Drop Shape Transfer for path 3-4, and Heat Transfer Shape
Factor for Path 3-4) and so each step will comprise 3 simulations.
4. Edit the default Working Side Inputs, Non-working Side Inputs, and Target Results
values to those required for your scenarios by clicking in the appropriate value in the
table and typing new value.
Tip
The Scenarios table supports the usual cut, copy, and paste functions allowing you to
use a text file containing your Input and Target results data to speed up your data
input.
5. Click OPTIMIZE.
The optimization scenarios are run and progress is shown on screen.

October 2020
Using VCSOP
Once all scenarios have completed the results (Reynolds Number, Shape Factor, and
%Error) are displayed.
6. You can return to the 1st step of the Wizard by clicking the PREVIOUS button.
7. Click FINISH to close the Shape Factor Optimization Wizard.
Results
Simcenter Flomaster creates the appropriate shape factor curves and assigns them to the heat
exchanger.

October 2020
Chapter 38
User Group Management
User Group Management is a means whereby system administrators can create login details for
users, assign roles to particular projects, apply permissions to roles, and set up and assign user
groups to selected roles.
There are two methods for managing users in Simcenter Flomaster:
• Individual User — Create individual users with individual permissions within each
project (legacy functionality)
• User Group/Role — Create users and add them to user groups, which are then assigned
to roles
Note
Use the legacy method only for the simplest of installations, where there are very few users
or projects. In earlier versions of Simcenter Flomaster, this method was the only way to
manage users; this method is provided and documented to support system administrators
managing users by this method.
For new installations, use the User Group/Role method to manage users.
Table 38-1 gives a summary of the two methods.

Table 38-1. User Group Management Methods
Method Recommended for Notes
Individual user Legacy • Each user is given a
permissions configurations only Simcenter Flomaster user account that
specifies permissions and catalogue
access rights.
• Users are assigned to a project.
User group All installations of • Each user is given a User Logon.
management Simcenter Flomaster • User Logons are assigned to User
Groups.
• User Groups, Permission Sets, and
Catalogue access sets are applied to
Roles, which are assigned to projects.
• Users can be assigned to multiple user
groups
• Multiple Permission Sets, Catalogue
Access Sets, and Roles can be created.

October 2020
The two methods of managing users are illustrated schematically in Figure 38-1and
Figure 38-2.
Figure 38-1. Individual User Permissions - Legacy Configurations Only

October 2020
Figure 38-2. User Group Management
User Group Management Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751

Deleting User Logons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Viewing Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Adding and Removing Users From a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Permission Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Viewing Permission Set Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Creating Permission Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Deleting Permissions Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
Catalogue Access Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
User Access Control - Legacy Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Creating Catalogue Access Permission Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Creating New Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Deleting Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769

October 2020
Parent Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770

Assigning Multiple Administrator Accounts in Active Directory . . . . . . . . . . . . . . . . . . . 773
Using GUI Automation Login Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774

October 2020
User Group Management Overview
User Group Management Overview

User access control using groups and roles is one of the methods of managing user permissions
in Simcenter Flomaster.
Each user is assigned a user login that includes a system name and password. By creating
groups of users with similar requirements and attaching these groups to roles, you can manage
the permissions of all of the users in the group. You then attach roles to projects, which provides
users access to that project and all of its sub-projects. This method of user management gives a
high level of flexibility for the system manager.
Note
When using User Groups to granting access to a project, users also gain access to all sub-
projects. When using Active Directory groups to grant access to a project, users are given
access to only the project to which their group is added, not any sub-projects. For more
information, refer to Assigning a User Group To a Role.
To set up user access control with groups and roles:
• Create logins for each user.

• Create user groups and add the user logins to them.
• Creating permission sets.
• Creating catalogue access sets.
• Create roles and apply user groups, permission sets, and catalogue access sets to these
roles.
Deleting User Logons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Viewing Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Adding and Removing Users From a Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Permission Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Viewing Permission Set Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Creating Permission Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Deleting Permissions Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
Catalogue Access Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
User Access Control - Legacy Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Creating Catalogue Access Permission Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765

October 2020
Creating User Logons

Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Creating New Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Deleting Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
Parent Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Assigning Multiple Administrator Accounts in Active Directory . . . . . . . . . . . . . . . . . . 773

Simcenter Flomaster administrators can create new user accounts.
You must be logged in as a Simcenter Flomaster administrator to create new
Simcenter Flomaster user logons.
Procedure
1. Select Tools > User Group Management > User Maintenance.
The User Logon Maintenance dialog box opens.
A new logon is added to the list as LogonName1.
3. Rename the logon name by entering a new Logon Name in the Properties pane.
4. Enter the users’ first and last names.
5. Enter the users' password and press the Return key to display the Confirm Password
dialog box.
6. Re-enter the password and click OK.
7. Enter the users' email address.
8. To allow users to log on using Windows Authentication, choose Yes.
Related Topics
Adding and Removing Users From a Group
Permission Sets
Catalogue Access Sets
Deleting User Logons

Simcenter Flomaster administrators can delete user accounts.

October 2020
Viewing Assignments

You must be logged in as a Simcenter Flomaster administrator to delete Simcenter Flomaster
user logons.
Procedure
The User Logon Maintenance dialog box opens.
2. Select the user that you want to delete and click the Delete button.
3. Click Yes to confirm the deletion.
Viewing Assignments
You can view the user groups, projects, and project roles to which users are assigned.
Procedure
Click the View Assignments button to display the User Assignments dialog box.

Simcenter Flomaster administrators can add and remove users from a group.
You must be logged in as a Simcenter Flomaster administrator to manage User Groups.
Procedure
1. With the User Logon Maintenance dialog box displayed, select the required user.
2. Click the Add/Remove From Groups button.
The Add or Remove From Group dialog box opens.
3. Use the check boxes to choose the groups to which you want to assign user membership.
4. Click OK to save the changes and close the Add or Remove From Group dialog box.
Related Topics
Permission Sets

October 2020
Creating User Groups
Creating User Groups

Simcenter Flomaster administrators manage users’ permissions by applying either Active
Directory Groups or Simcenter Flomaster User Groups to roles. When assigned either type of
group, users are only able to perform the functions that are relevant to that group.
Procedure
The User Group Selection dialog box opens.
2. Click the New button to display the User Group Update dialog box.
The User Group Update dialog box shows a list of all the available users.
3. Assign the group a name and description.
4. Add users to the group by selecting each user and clicking the Add button to move the
user into the Group Members list.
Deleting User Groups

Simcenter Flomaster administrators can delete Simcenter Flomaster user groups.
Procedure
2. Select the group that you want to delete and click the Delete button.
Permission Sets
A permission set is a collection of individual permissions that you can apply to a role. Each
permission set contains several individual permissions such as the ability to create and edit

October 2020
Permission Sets
networks or the ability to create and edit catalogues. Simcenter Flomaster contains some
supplied permission sets you can use or edit, or you can create your own.
Table 38-2. Simcenter Flomaster Supplied Permission Sets

Permission Catalogue Project
Set
Designer Editor Admin Engineer Exporter Importer Reviewer Viewer
User Admi No
n
Project Cre No
ator
Project Sha No
re
Catalogue Yes No
Creator
Catalogue Yes No Yes No
Data Editor
Catalogue No
Data Protec
t
Network Cr No Yes No
eator
Network C No Yes No
onfig
Network D None High Intermedi None
ata Editor ate
Results Cre No Yes No
ator
Allow Pack No Yes No Yes No
Allow Unp No Yes No Yes No
ack
Allow Sign No Yes No Yes No
off
Hybrid Res No Yes No
ult Creator
Upgrade V No Yes No
6x Data
Script Acce No
ss Database

October 2020
Viewing Permission Set Roles
Related Topics
Viewing Permission Set Roles

You can view the roles to which a permission set is assigned.
Procedure
1. Select Tools > User Group Management > Maintain Permission Sets.
The Permission Sets dialog box is displayed.
2. Select the Permission Set and click the Roles button.
The roles that the permission set is assigned to are displayed in a dialog box.
Creating Permission Sets

You can create and update permission sets.
Procedure
1. Select Tools > User Group Management > Maintain Permission Sets.
Note
You can view individual permissions for any existing permission set by selecting the
required set and clicking the Update button.
2. Click the New button to display the Edit Permission Set dialog box.
3. Set the permissions as described in the table.
Table 38-3. Creating Permission Sets

To Do this
Change the permission set name Click in the cell adjacent to Permission Set
Name and enter the required name.
Give users administrator level access Select Yes in the cell adjacent to User
Administrator Project Share.

October 2020
Table 38-3. Creating Permission Sets (cont.)

To Do this
Allow users to create projects Select Yes in the cell adjacent to Project
Create.
For more information, see Creating a New
Project
Allow users to share projects Select Yes in the cell adjacent to Project
Share.
For more information, see Sharing Projects.
Assign the permission Catalogue Creator Select Yes in the cell adjacent to Catalogue
status Creator.
For more information, see Catalogues.
Assign the permission Catalogue Data Select Yes in the cell adjacent to Catalogue
Editor status Data Editor.
Allow users to set the Protected Data Select Yes in the cell adjacent to Catalogue
property on catalogues Data Protection.
For more information, see Catalogues.
Assign the permission Network Creator Select Yes in the cell adjacent to Network
status Creator.
For more information, see Using Command
Line Utilities to Create a New Network.
Assign the permission Network Select Yes in the cell adjacent to Network
Configurator status Configurator.

October 2020
Table 38-3. Creating Permission Sets (cont.)

To Do this
Assign the permission Network Data Editor Click in the cell adjacent to Network Data
status Editor to display a dropdown menu. Choose
one of the following options:
• 0 = None
• 1 = Lowest security level
Users cannot access data that has been
assigned Intermediate or High security
level status.
• 2 = Intermediate security level
Users can access low-level security data,
but they cannot access data that has been
assigned High security level status.
• 3 = High security level
Users can access all three levels of data.
• 4 = Administrator Only
Prevents access to all data unless the user
has Simcenter Flomaster administrator
access.
Assign the permission Results creator status Select Yes in the cell adjacent to Results
Creator.
Assign the permission Pack status Select Yes in the cell adjacent to Allow
Pack.
Assign the permission Unpack status Select Yes in the cell adjacent to Allow
Unpack.
Assign the role Allow Sign-off status Select Yes in the cell adjacent to Allow Sign
off.
Allow users to create hybrid results Select Yes in the cell adjacent to Hybrid
Results Creator.
For more information, see Hybrid Results
Assign the role Upgrade V6x Data status Select Yes in the cell adjacent to Upgrade
V6x Data.
Allow users access to the database via Select Yes in the cell adjacent to Script
scripts. Access Database.
For mo
re information about scripts, see Catalogues
- Scripts.

October 2020
Deleting Permissions Sets
Note
When creating a new permission set, you can copy an existing permission set by
selecting it and clicking the Copy button. This can save time when creating
permission sets with similar values.
Deleting Permissions Sets

You can delete a permission set after removing it from roles to which it is assigned.
You cannot delete a permission set without first removing it from any roles to which it is
assigned. See “Roles” on page 766. You can determine which roles a permission set is assigned
to by clicking the Roles button from the Permission Sets dialog box.
Procedure
1. From the Properties pane, right-click in the cell next to the Permission Set to expose a
button.
2. Select the permission set you want to delete and click the Delete button.

A Catalogue Access Set is a collection of access rights for items that are included in the
Catalogues tab.
• Components
• Materials
• Performance data
• Scripts
• Sub-systems
• Symbols
Simcenter Flomaster contains some supplied Catalogue Access Sets, but you can also create
your own.
Related Topics

October 2020
Permission Sets

October 2020
User Access Control - Legacy Configurations

For each user, you must create a user account that contains the user name, password details,
individual permissions, and catalogue access details. You create the user account within a
project and grant access (according to the individual permissions) to that project and all its sub-
projects.
You are advised to only use individual user accounts for small groups of users.
For large groups of users, consider using the User Group Management options, which allow you
to set logins for users, assign roles to projects, create user groups, and assign users to these
groups. Refer to “User Group Management Overview” on page 751
Creating User Accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761

Copying User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Deleting User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Creating User Accounts

Create the user account at the highest level in the Simcenter Flomaster project hierarchy for
which you want to provide the user access.
If you need to give a user different levels of access within different projects, you must create a
separate user account (with a different user name and permissions) under each project for which
you want to provide the user access.
Procedure
1. Right-click the project and choose New User.
A legacy functionality warning is displayed.
2. Click Yes to continue.
The new user account is added to the project with a default name, and its properties
display in the bottom pane. A message informs you that the password is blank.
3. Click OK to close the message.
Note
Initially, all properties are set to No.
4. Enter a user name in the Name field.

5. Enter a password in the Password field and press the Return key.
A Confirm Password dialog box opens.

October 2020
Note
Users who have logged in previously can change their own password.
6. Re-enter the password and then click OK to confirm the new password.
7. Assign values to the remaining properties, as shown in the table.
Property Description
User Administrator When set to 1(Yes), users can create and edit
the user accounts of other users.
Project Creator When set to 1(Yes), users can create and
delete projects.
Project Share When set to 1(Yes), users can share projects.
For more information about sharing
projects, refer to “Sharing Projects” on
page 51.
Catalogue Creator When set to 1(Yes), users can create and
populate sub-catalogues (under the
Simcenter Flomaster supplied analytical
models, components, materials,
performance data, scripts, and symbols
catalogues).
Catalogue Data Editor When set to 1(Yes), users can add items to
any user-created catalogues.
Catalogue Data Protect When set to 1(Yes), users can set the
protected status for any user-created
components, materials, performance data,
and scripts.
Network Creator When set to 1(Yes), users can create new
networks and amend networks that they
previously created.
Network Configurator When set to 1(Yes), users can move
components and break and create
connections between components. Applying
this permission does not give users the
ability to add new components to a network.

October 2020
Network Data Editor Use this property to control the users ability
to edit component and node data (for
networks to which they have access). Valid
settings:
• 0 = None
• 1 = Lowest security level. Users cannot
access data that has been assigned
Intermediate or High security level
status.
• 2 = Intermediate Security level. Users
can access low-level security data, but
they cannot access data that has been
assigned High security level status.
• 3 = High security level. Users can access
all three levels of data.
• 4 = Administrator-only level. Prevents
access to all data unless the user has
Simcenter Flomaster administrator
access.
Results Creator When set to 1(Yes), users can move
components, break and create connections
between components, and run simulations.
Applying this permission does not give a
user the ability to add new components to a
network.
Allow Pack When set to 1(Yes), users can pack networks
and projects (for which they have access).
For information about packing and
unpacking, refer to “Pack and Unpack” on
page 455.
Allow Unpack When set to 1(Yes), users can unpack
networks and projects. For information
about packing and unpacking, refer to “Pack
and Unpack” on page 455.
Allow Signoff When set to 1(Yes), users can protect results
by signing them off. For information about
signing off results, refer to “Protecting
Result Sets” on page 432.
Hybrid Result Creator When set to 1(Yes), users can create hybrid
results. For information about hybrid results,
refer to Hybrid Results.

October 2020
Upgrade V6.x Data When set to 1(Yes), users can upgrade
projects and networks (to which they have
access) from version 6.x to V7.
Script Access Database When set to 1(Yes), users can access the
database by Simcenter Flomaster scripts.
Available Catalogues Use this property to control users access to
components, materials, performance data
scripts, subsystems, and symbols. To set
catalogue access:
1. Click in the cell next to Available
Catalogues to display a button, and click
it. The User Catalogue Assignment
dialog box opens.
2. To assign a catalogue, click the
associated check box. As you do this, the
red light next to each catalogue changes
to green. If you expand an entry, the tree
expands to show all sub-catalogues for
that entry. Use this feature to select
individual items or groups of items.
Note
The Permissions Set and Catalogue Access Sets only apply to the project (and any
sub-projects) under which that the user login was created.
Related Topics
Copying User Accounts
Deleting User Accounts

If you need to create several users with similar access permissions it can be quicker to copy an
existing user account. When you copy a user account the new account is given a new name and
the password is left blank. You can modify the user name, password, and any of the
permissions.
Procedure
Right-click on the user that you want to copy and choose Copy from the menu.

October 2020
Viewing Roles for Catalogue Access Sets
The user account is copied, and a warning message that the password field is blank is
displayed.
Related Topics

You can delete user accounts.
Procedure
1. Right-click the user account that you want to delete and choose Delete from the menu.
A confirmation dialog box is displayed.
Related Topics
Viewing Roles for Catalogue Access Sets

You can view the roles to which a Catalogue Access Set is assigned.
Procedure
1. Select Tools > User Group Management > Maintain Catalogue Access Sets.
The Catalogue Access Sets dialog box opens.
2. Select the Catalogue Access Set you want, and click the Roles button.
The roles that the Catalogue Access Set is assigned to appear in the dialog box.
Creating Catalogue Access Permission Sets

You can create new Access Permission Sets.
Procedure
1. Select Tools > User Group Management > Maintain Catalogue Access Sets

October 2020
Deleting Catalogue Access Permission Sets
2. Click the New button to display the Catalogue Access Set dialog box.
3. Enter a name for the Catalogue Access Set.
4. Set the permissions as required, as described below.
5. To select all the catalogues for a specific set, click the associated check box.
The traffic light symbol changes to green.
6. To select specific catalogue items within a set, click the button to expand the tree and
then select the required items.
Note
The traffic light symbols indicate the status of the items in a folder. A selected item,
or a folder in which all items are selected, is green. An item that is not selected, or a
folder in which all items are unselected, is red. A folder that contains both selected and
unselected items is yellow.
Deleting Catalogue Access Permission Sets

You can delete an Access Permission Set after removing the role to which it is assigned.
You cannot delete a Catalogue Access Set without first removing the role to which it is
assigned. See “Roles” on page 766. You can determine which roles a catalogue access set is
assigned to by clicking the Roles button from the Catalogue Access Sets dialog box.
Procedure
1. Select Tools > User Group Management > Maintain Catalogue Access Sets.
2. Select the Catalogue Access Set that you want to delete and click the Delete button.
Roles
You first assign a role to a project and then apply a Permission Set, a Catalogue Access Set, and
a User Group to the role. After you have done this, members of the User Group are granted the
permissions (according to the Permission Set and Catalogue Access Set) for that project.
Users’ access to sub-projects depends on the type of groups assigned to the role.
• User Groups — Assigning a user group to a role attached to a project gives the group
members access to that project and all of its sub-projects.

October 2020
Creating New Roles
• Active Directory User Groups — Assigning an Active Directory group to a role

attached to a project gives group members access to that project only.
When adding a role to a project you can use any of the following Simcenter Flomaster
preassigned roles, create a new role, or choose and Active Directory group.
Simcenter Flomaster preassigned roles:
• Project Administrator/Designer
• Project Engineer
• Project Viewer
• Project Reviewer
• Project Importer
• Project Exporter
• Catalogue Designer
• Catalogue Editor
Multiple Roles in a Project

You can assign multiple roles to a project. If, due to being included in multiple user groups, a
user is given different permissions within the same project, the higher of each individual
permission or catalogue access permission applies.
Creating New Roles

Administrators can create new roles.
You must be logged on as an administrator to create or edit roles.
Procedure
1. Select the Roles tab in the Project View pane.
2. Select the project that you want to add the new role to and select New Role > New Role
from the right mouse button popup menu. A new role is created in the project and given
a default name.
The properties of the new role are displayed in the bottom section of the Project View.
3. Rename the role by entering a new name in the Name field.
4. Assign a permission set to a role.

October 2020
Creating New Roles
a. Click the button next to the Permission Set field.

The Permission Sets dialog box opens.
b. Select the required permission set and click the Select button.
Note
You can also create new roles, delete roles, and update permission sets from the
Permission Sets dialog box.
5. Assign a catalogue access set to the role.

a. Click the button next to the Catalogue Access Set.
b. Select the required permission set and click the Select button.
Note
You can also create new roles, delete roles, and update permission sets from the
Permission Sets dialog box.
6. Assign a User Group.

You can add Simcenter Flomaster user groups or Active Directory user groups to a role.
a. Click the button next to the User Groups field.
The Assigned User Groups dialog box opens.
b. To add an existing user group:
i. Click the Add button.
ii. Select the required permission set.
The description and members of the user group appear in the bottom panes of the
User Group Selection dialog box.
iii. Click the Select button to add the group to the role.
iv. To add more user groups, repeat steps a, b, and c.
To add an Active Directory User Group:
a. Select the Use Active Directory check box, and click the Add button.
The Select Group(s) dialog box opens, which provides a range of search options;
such as the following:
o Searching from the root of the current domain (the default option).

October 2020
Deleting Roles
o Lightweight Directory Access Protocol (LDAP), which is an Internet protocol

that email and other programs use to look up information from a server.
You can narrow down the Active Directory Groups by entering a term in the Group
name filter string field and clicking Search.
a. Select the required groups and click OK.
7. Click Close.
Deleting Roles
Administrators can delete roles.
You must be logged on as an administrator to edit or delete roles.
Procedure
1. Select the role that you want to delete, and then right-click and choose Delete from the
popup menu.
A confirmation dialog box is displayed.

October 2020
Parent Role
Parent Role
In implementations with many projects and sub-projects, management of users by roles
becomes complex, but you can simplify the process by using parent roles. By specifying that a
role has a parent role, any changes to the permissions of the parent role are automatically
applied to the child role.
An example project, called “Fuel Injections Systems,” illustrates using parent roles to simplify
user management.
Parent Role Example Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770

Setting Permissions Without Using the Parent Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Setting Permissions Using the Parent Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Setting the Parent Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Removing the Parent Role From a Child Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Parent Role Example Project

The process of using parent roles to simplify user management is illustrated with an example
project called “Fuel Injections Systems.”
The example project, “Fuel Injections Systems” contains five sub-projects:
• Central Port
• Continuous Injection
• Direct Injection
• Multiport
• Single Point
Project engineers use these sub-project to organize the networks that they use when designing
fuel injection systems. Individual project engineers may be assigned to one or several of the five
sub-projects, but their permissions within that project (what they can create or edit and which
catalogue items they have access to) are the same for every sub-project.
Refer to
Setting Permissions Without Using the Parent Role

You can set up permissions without using the parent role.
Procedure
1. Create a user group for each of the five sub-projects.

October 2020
Parent Role
• Central Port
• Multiport
• Single Point
2. Create a role called “Project Engineer” within each of the five sub-projects.
3. Assign a permission set and catalogue access set to each of the five Project Engineer
roles.
4. Assign the five user groups to the correct roles.
When complete, the projects and roles look like this:
In this system, if a user is assigned to a new project, the administrator adds their name
into the appropriate group (for example “Multiport Project Engineers”); the user then
has access to that sub-project.
If later, if the administrator decides that the Project Engineer permissions in all sub-
projects need to change, the administrator must change the permission set for each of the
roles in each of the five subsystems (the roles highlighted in the following figure.

October 2020
Parent Role
Setting Permissions Using the Parent Role

You can set up permissions using the parent role. By setting a parent role and referencing the
other roles to it, the administrator can make permission changes across all sub-projects with
only one change.
Procedure
1. Create a user group for each of the five sub-projects.
• Central Port
• Multiport
• Single Point
2. Create a role called “Project Engineer” within the Fuel Injection Systems (parent)
project and assign a permission set and catalogue access set to it.
3. Create roles called “Project Engineer” within the five sub-projects and specify that the
“Project Engineer” within the Fuel Injection Systems (parent) project is the parent role.
When complete the projects and roles look like this:
If later, the administrator decides that the Project Engineer permissions in all
sub-projects need to change, the administrator must only change the permission set for
the “Project Engineer” role in the Fuel Injection Systems (parent) project (highlighted in
the previous figure). The change in permissions hen applies to all child roles.
Setting the Parent Role

You can specify the parent role from a child role.

October 2020
Assigning Multiple Administrator Accounts in Active Directory

The parent role must be higher in the project hierarchy than the child role.
Procedure
1. From the Roles tab in the Project View, select the child role.
The properties for the child role appear in the bottom part of the pane.
2. Set Inherit Permission Set to 1.Yes.
3. Set the Inherit Catalogue set to 1.Yes
4. Click the button in the ParentRole field.
The Choose Parent Role dialog box opens.
5. Select the role you want as the parent role.
6. Click the Select button to set the parent role and close the Choose Parent Role dialog
box.
Removing the Parent Role From a Child Role

You can remove a parent role.
Procedure
1. From the Roles tab in the Project View, select the child role.
The properties for the child role appear in the bottom part of the pane.
2. Click the button in the ParentRole field.
The Choose Parent Role dialog box opens.
3. Click the Not Set button and click Yes in the confirmation dialog box.
Assigning Multiple Administrator Accounts in

Active Directory
You can assign multiple Active Directory Administrators.
Procedure
1. Log in to Simcenter Flomaster using the built-in Admin Role. Refer to Logging-on to
Simcenter Flomaster“Starting Simcenter Flomaster” on page 29 for more information
about logging in.
2. Select Tools > Options, and then choose the Security tab.

October 2020
Using GUI Automation Login Functions
3. Click Add to open the Select Group(s) dialog box.

This dialog box shows the user groups that contain Active Directory Administrator
permissions.
By default, the groups are found from a search from the root of the current domain. By
clearing the Search from the root of the current domain and entering an alternative
directory in the Alternative LDAP search root string, you can search other domains.
You can filter the groups returned by entering a term in the Group name filter string:
field.
4. Select the required groups and click OK.
The Select Group(s) dialog box closes and the groups are added to the AD Administrator
Groups field of the Options dialog box.
5. Click Apply and then OK to close the dialog box.
Note
When you are logged in as an Active Directory Administrator, the built-in Admin
role is no longer visible. When you view the Roles under a Project (from the Roles
tab in the Project view) you will only see the Active Directory groups. When you are
logged in as an Active Directory user, you cannot remove any Active Directory Groups
to which you currently belong.
Results
When logging in, Active Directory users will be able to select an Active Directory
Administrator role from the Choose Roles dialog box.

You can use GUI Automation functions to log in to User Group Management projects.
For example, the implementation is a main project called “Test Project,” which has the role
“Tester” assigned to it. Tester is assigned to the user group called “Testers” (which contains one
user).

October 2020
The sub-project “Dev Project1” has the role, “Developer,” assigned to it. Developer is assigned
to a user group called “Developers,” which has two users.
By using GUI Automation functions, you can do the following:
• Log in to Simcenter Flomaster.

• Log in to a parent project as a user who is assigned to a role.
• Log in to a sub-project as a user who is assigned to a role.
• Log in using Windows Authentication.
• Log in to a project as a role-based user.
The following are code examples of the logins described above.
Logging In to Simcenter Flomaster

The following code is to required to log in to Simcenter Flomaster as an Admin user:
Dim fm As Flowmaster_Automation_Gui.Application
Dim bIsLogedIn As Integer
Set fm = New Flowmaster_Automation_Gui.Application
bIsLogedIn = fm.DatabaseLogin("Server Name", "Database Name",
"Flowmaster", "admin", "")
If (bIsLogedIn = 1) Then
MsgBox ("Successfully logged into Flowmaster")
Else
MsgBox ("Error in login into Flowmaster")
End If

October 2020
Example 1 - Logging In to a Parent Project

Use this code to log in to the Test project as TesterD with the Password 12345:

bIsLogedIn = fm.DatabaseLogin("Server Name", "Database Name", "Flowmaster\
Test Project", "Tester", "12345")
MsgBox ("Successfully logged with new user")
Else
MsgBox ("Error in login with new user")
End If
Example 2 - Logging In to a Sub-Project

Use this example to log in to the sub-project Dev Project1 as TesterD with the Password 12345:

bIsLogedIn = fm.DatabaseLogin("Server Name", "Database Name", "Flowmaster\
Dev Project1", "Tester", "12345")
MsgBox ("Successfully logged with sub project")
Else
MsgBox ("Error in login with sub project")
End If
Example 3 - Logging In Using Windows Authentication

The following conditions apply when using Windows Authentication:
• Users must use the same login name that they would normally use to log in to
• Users must have Windows Authentication assigned to them.
This example shows how a user who is a member of the Testers group logs in to the Test
project.
Note
The password field is blank.

bIsLogedIn = fm.DatabaseLogin_2("Server Name", "Database Name",
"Flowmaster\Test Project", "WA", "", "Tester")
MsgBox ("Successfully logged with WA")
Else
MsgBox ("Error in login with WA")
End If
Example 4 - Logging In as a Role-Based User

Use this example to log in to the sub-project Dev Project1 as the role-based user JohnD, who as
a member of the Developers group and assigned to the Developer role.

October 2020

bIsLogedIn = fm.DatabaseLogin_2("Server Name", "Database Name",
"Flowmaster\Dev Project1",
"Developers", "12345", "Developer")
MsgBox ("Successfully logged with role based user")
Else
MsgBox ("Error in login with role based user")
End If

October 2020

October 2020
Chapter 39
Configuring Simcenter Flomaster
There are many aspects that you can configure. You can specify the appearance of the Network
Drawing window (such as the link properties, text and grid options, color, pipe style, and
background images), the default units that are used, and symbol sets for components.
Schematic Configuration Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
Maintaining Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Applying a Unit Set for an Individual Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Managing Unit Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Maintaining Symbol Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
Maintaining Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797

October 2020
Schematic Configuration Dialog Box

To access: Network > Schematic Configuration, or right-click in the Network Drawing and
choose Schematic Configuration
Use the Schematic Configuration dialog box to configure the Network Drawing window.
Description
The Schematic Configuration dialog box has four tabs to configure the following aspects of the
Network Drawing window:
• General Options — Set link and text properties and grid options.
• Colour Control — Change the color of components and connections in the Network
Drawing window.
• Pipe Configuration — Configure pipe colors and styles. These settings become the
defaults for any subsequent pipes you place in the Network Drawing window.
• Image Import — Add a background image to the Network Drawing window. For
example, import an engineering diagram and overlay the Simcenter Flomaster
components on the background image.

October 2020
Figure 39-1. Schematic Configuration Dialog Box — General Options Tab

October 2020
Figure 39-2. Schematic Configuration Dialog Box — Colour Control Tab

October 2020
Figure 39-3. Schematic Configuration Dialog Box — Pipe Configuration Tab

October 2020
Figure 39-4. Schematic Configuration Dialog Box — Image Import Tab
Objects
Table 39-1. Schematic Configuration Dialog Box — General Options Contents
Object Description
Link Properties
Link Thickness Choose a value from the dropdown list.
Default Link Type Select Straight or Orthogonal.
Avoid Nodes Click the check box to turn the option on or off.

October 2020
Table 39-1. Schematic Configuration Dialog Box — General Options Contents

Object Description
Text Options Note: For more network text options, refer to “Adding
Text, Lines and Boxes to Networks” on page 73.
Network Text Set the network text on/off.
Node Text Set the node text on/off.
Component Text Set the component text on/off.
Component ID Set the component ID on/off.
Node ID Set the node ID on/off.
Default Network Font button 1. Click the button to display the Font dialog box.
2. Select the required font, style, size, and so on, and then
click OK.
Results/Data Decimal Places Set accuracy of results and data decimal places when
displayed in Network Drawing window.
Grid Options
Show Grid Select to show the grid.
Snap to Grid Select to snap the drawing to grid.
Grid Colour 1. Click the button to display the Colour dialog box.
2. Select the color, and then click OK.
Grid Style Select the grid style from the following options:
• Cross
Grid Width Select the grid width in
Grid Cell Size Select the grid cell size.
Node Selection
Activate Select to activate node selection.
Capture Area Set the node capture area.
AutoSave
Activate AutoSave every Select the check box to activate the AutoSave feature, and
then choose the number of minutes from the dropdown list.
Table 39-2. Schematic Configuration Dialog Box — Colour Control Contents

Object Description
Background Colour button 1. Click the button to display the Colour dialog box.

October 2020
Table 39-2. Schematic Configuration Dialog Box — Colour Control Contents

Object Description
Node Colour Click the following buttons to select the color.
• Solid
• Hydraulic
• Mechanical
Port Colour Click the following buttons to select the color.
• Mechanical Link Colour
• Signal Link Colour
• Solid Link Colour
• Incomp. Link Colour
Link Colour Click the following buttons to select the color.
• Solid
• Hydraulic
• Incompressible
• Compressible
• Signal In
• Signal Out
Table 39-3. Schematic Configuration Dialog Box — Pipe Configuration

Contents
Object Description
Default Pipe Properties
Pipe Colour (Inner) button 1. Click the button to display the Colour dialog box.
Pipe Colour (Outer) button 1. Click the button to display the Colour dialog box.
Page Width Select the page width from the dropdown list.
Default Pipe Style Select Straight or Flexible.
Pipe Label Select to Show or Hide the label.
Default Adjusting Style Select the Ends, Scale, or Stretch adjusting style.
For more information, refer to the following topics:
• Setting the End Style Option for Pipes
• Setting the Scale Option for Pipes
• Setting the Stretch Option for Pipes

October 2020
Note
The pipe property settings you apply using the Pipe Configuration tab are the default
settings. This means that any changes you make are automatically applied to any pipes you
subsequently place in the Network Drawing window.
Table 39-4. Schematic Configuration Dialog Box — Image Import Contents

Object Description
Image Import
Browse button 1. Click the Browse button. The Open dialog box opens.
2. Navigate to the required folder and select the image, which
can be in one of the following formats:
• .bmp
• .gif
• .jpg
3. Click Save to save the image.
Deselect button Click to deselect the image.
Format Image/Document
Specify document Units Choose an option from the dropdown list:
• pixel
• millimeters
Specify image size Enter the X and Y values.
Scaling Factor Enter the scaling factor.
Apply button Click to apply your selections.
OK button Click to close the dialog box.

October 2020
Maintaining Units
Maintaining Units
You can specify the units for variables and results. Simcenter Flomaster contains standard Unit
Sets and you can create and manage your own custom Unit Sets.
The following are the Simcenter Flomaster Unit Sets:
• Company (default)
• Imperial
• Metric
• Oil & Gas
• American
• Oil Hydraulic
Your login status determines which Unit Sets you can manage and view.
Table 39-5. Unit Access
Login Status Access
Administrator • View all the available Unit Sets.
• Associate any Unit Set to a project (including sub-
projects of the top-level project).
• Delete unwanted user-defined Unit Sets.
• Copy and edit user-defined Unit Sets.
Project User (with Catalogue • Change the Unit Set assigned to the project.
Editor or Catalogue Designer • See which user-defined Unit Set (if any) is assigned
role) to the project.
• Create or edit your own Unit Set.
• View or choose another user's Unit Set.
Project User (with any other • Change the Unit Set assigned to the project.
role) • See which user-defined Unit Set (if any) is assigned
to the project.1
• Create or edit your own Unit Set.
• View or choose another user's Unit Set.2
1. Resolved by sharing the project.
2. Resolved by setting up a share between the relevant projects.

Applying a Unit Set for an Individual Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Managing Unit Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790

October 2020
Specifying the Unit Set for a Project
Specifying the Unit Set for a Project

You can specify which Unit Set (“Company” is the default) is used for all networks under a
given project. This setting is persistent between log-ins and applies to all users of the project.
• You must have Administrator level access to set the project Unit Set.
• You can specify the Unit Set for any project but those changes will only apply if you
log-in to that project directly (rather than logging into another project and then
navigating to the changed project).
You can specify the log-in project from the Launchpad under the Logon section.
Procedure
1. Select the project.
Note
You can apply the Unit Set to any project (including the top level project) or sub-
project.
The project’s properties are displayed in the bottom, left-hand pane.

2. Click the [...] button in the Unit Set field.
The Select Unit Set dialog box opens.
3. Choose a Unit Set and click OK.
Applying a Unit Set for an Individual Session

You can apply a Unit Set which is applicable for the current session only. Session Unit Sets are
applicable to the user who makes the change only.
Procedure
1. From Tools > Units choose Select Session Unit Set...
The Select Unit Set dialog box opens.
2. Choose a Unit Set and click OK.
Results
The Unit Set is applied to all projects and their networks for the duration of that log-in. Upon
the next log-in the previous Unit Sets will be in effect.

October 2020
Managing Unit Sets
Managing Unit Sets

You can copy Simcenter Flomaster supplied Unit Sets as a basis for your own custom Unit Sets.
You can re-name and delete custom Unit Sets.
• You must have Project User (with Catalogue Editor or Catalogue Designer role) access
to create or edit a custom Unit Set.
• You must have Administrator access to delete a custom Unit Set. You cannot delete a
Simcenter Flomaster supplied Unit Set.
Procedure
1. Click Tools > Units and select Unit Maintenance...
The Unit System Update dialog box opens.
Figure 39-5. Unit System Update Dialog Box

October 2020
Editing Unit Sets
2. You have a choice:
To Do this
Copy a Unit Set 1. Select the Unit Set that you want to copy.
2. Click the Copy Unit Set... button.
The Copy Unit Set dialog box opens.
3. Enter the new name and click OK.
The copy is added to the list of available Unit Sets.
Rename a Unit Set 1. Select the Unit Set that you want to rename.
2. Click the Rename Unit Set... button.
The Rename Unit Set dialog box opens.
3. Enter the new name and click the OK.
Delete a Unit Set 1. Select the Unit Set that you want to delete.
2. Click the Delete Unit Set... button.
The Confirm Deletion dialog box opens.
3. Click OK.
Editing Unit Sets

You can edit any custom (user created) Unit Sets by adding or removing units or specifying
different default units.
• Editing Unit Sets requires Project User or higher permissions. For information on User
Permissions see “User Group Management” on page 747.
You can only edit custom (user created) Unit Sets. To edit those supplied by Simcenter
Flomaster you must first make a copy and edit that. See “Managing Unit Sets” on
page 790 for more information.
Procedure
1. Click Tools > Units and select Unit Maintenance...
The Unit System Update dialog box opens.

October 2020
Editing Unit Sets
Figure 39-6. Unit System Update Dialog Box

October 2020
Editing Unit Sets
To Do this
Add New Units to 1. Select the required unit quantity (for example, Width).
the Unit Quantity The unit properties are displayed in the right-hand
setup pane.
2. Click the Add New button.

The unit is added as “New Symbol,” and is displayed
in the bottom, right-hand pane.
3. Click in the appropriate cell to change the name or set

the Factor or Offset.
Add an existing unit 1. Select a Unit Set in the top left pane.
to the Unit Quantity Its associated units are displayed below.
setup
2. Select the unit quantity, (for example, Width) to
display its properties in the right-hand pane.
3. Click Add Existing.
The Select Existing Unit dialog box opens.
4. Scroll down the list and select the unit and click OK.
5. Assign the unit to the selected unit quantity by clicking
in the value cell next to Width and then clicking the
S... button to display the Default Unit dialog box.
6. Select the required unit and click OK

October 2020
Editing Unit Sets
To Do this
Delete a unit 1. Select the unit quantity (for example, Angle).
belonging to a The unit properties are displayed in the right-hand
specific unit pane.
quantity.
2. To delete a unit, select it.

In this example, “deg” is selected.
3. Click the Delete button.
The Confirm Deletion dialog box opens.
4. Click Yes to delete the unit.
Specify which unit is 1. Click in the value cell for the required unit (for
presented as default example, Angle) to display the D... and S... buttons.
for a given Unit Set. Note: The S... button will be unavailable if:
• The Unit Set is one of the Simcenter Flomaster
supplied Unit Sets - in this instance make a copy of
the unit Set to edit.
• You do not have the permissions required to make
this change. See “User Group Management” on
page 747 for information on setting User
Permissions.
2. Click the S... button.
The Select Default Unit dialog box opens.
3. Select the unit that you want to be the default and click
OK
Tip: The selected item (“deg” in the example
above) is highlighted by a >.

October 2020
Maintaining Symbol Sets
To Do this
Display units for any 1. Click in the value cell for the required unit (for
selected unit example, Angle) to display two buttons.
quantity. 2. Click the D... button.
The Unit Details dialog box opens.

To maintain symbol sets:
Procedure
1. Choose Symbol Sets from the Edit menu.

October 2020
The Maintain Symbol Sets dialog box is displayed:

Figure 39-7. The Maintain Symbol Dialog Box.
The dialog box enables you to choose an alternative symbol set and to create new
symbol sets.

Set the symbol set 1. Select the required symbol set.
order 2. Click the Up or Down arrows to set the order of precedence.
3. To set the selected symbol set as the current set, click the Select
Current button.
Create a new symbol 1. Click the Add button. The new symbol set is added to the list
set name as: 'Edit Name'.
2. Click in the field and enter the new name (e.g.
My_NewSymbols).
3. Add symbols to the set.

October 2020
Maintaining Features

Delete a symbol set 1. Select the symbol set you want to delete.
name 2. Click the Delete button. A confirmation dialog box is
displayed.
Note: You cannot delete Simcenter Flomaster supplied symbol
sets. You can only delete those you have created.
The Maintaining Features option enables you to perform maintenance operations on items such
as Curves or Equations, and Integer or Real features.
Procedure
1. From the Tools menu, select Maintaining Features.
The Maintaining Features dialog box is displayed.
Table 39-6. Maintaining Features

To view a feature Expand the feature set (for example, Script) to see all the available
features.
Selecting a feature will, if the Help check box is flagged, display
information about that feature in the lower pane of the dialog box.
To see where a Right-click a feature and select the Show Usage... option.
feature is used The Feature Usage dialog box, which provides details of where that
feature is used, is displayed.
To edit a feature Right-click a feature and select the Edit... option.The feature
dialog box opens from which you can edit the Name and
Description of the feature.
To delete a feature Right-click a feature and select the Delete option.
If the feature is used in Simcenter Flomaster you are prohibited
from deleting the feature, otherwise the feature is deleted.
Note
You can only edit or delete user created features.
2. Click Close to close the Maintain Features dialog box.

October 2020

October 2020
Chapter 40
Database Functions
You can perform database functions such as managing the size of the database and files and
backing up and restoring your database.
Searching the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Opening the Database Search Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Shrinking a Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
Using SQL Server Management Studio to Shrink the Database . . . . . . . . . . . . . . . . . . . . 806
Shrinking the Database Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807
Restoring a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Database Recovery Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Setting the Directory Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
Using the Database Reporting Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Hybrid Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
Checking Result Sets In and Out of the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815

October 2020
Database Functions
Searching the Database
Searching the Database

You can perform searches the Simcenter Flomaster database to return Analytical Models,
Components, Materials, Performance (such as Curves and Surfaces), Scripts and Macros, and
Symbols. Often when working with components you will search the database to find
appropriate items such as curves, materials, or scripts.
Table 40-1. Video Topics Relating to the Searching the Database

Task Video
Searching the Database: Quick Search
Searching the Database: Using the Database

Search Tool
Opening the Database Search Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800

Using the Database Search Tool - General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
Using the Database Search Tool - Data Item Specific Search Terms. . . . . . . . . . . . . . . . . 804
Opening the Database Search Tool

You can use the Simcenter Flomaster database search tool (a dialog box called Selection From
Catalogue) to search and select Simcenter Flomaster items. You can open the dialog box from
any of the catalogues (such as Components or Scripts) or by clicking the search button from a
component’s data form.
Procedure
1. To open the Database Search Tool from the Catalogues tab:
a. Right-click over a folder which contains the type of item you are searching for (for
example to search for a script, right-click over the Scripts folder) and select Search
from the menu.
2. To open the Database Search Tool from a component’s data form:
a. Click the Select Item button, .

October 2020
Database Functions
Using the Database Search Tool

The database search tool (the Selection from Catalogue dialog box) allows you to browse and
filter items in the Simcenter Flomaster database. The dialog box contains generic fields, which
are present for all searches, and those which are specific previous selections.
Using the Database Search Tool - General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
Using the Database Search Tool - Data Item Specific Search Terms . . . . . . . . . . . . . . . 804
Using the Database Search Tool - General

When searching for database items many of the options that you can use are common to all
Simcenter Flomaster items.
The tool contains four panes:
• The top, left-hand pane displays the catalogues which you can browse.
• You use bottom, left-hand pane to define filter criteria.
• The top, right-hand pane displays the results of your search (filtered items).
• The bottom, right-hand pane shows the properties for items selected in the Filtered items
pane.

October 2020
Database Functions
Figure 40-1. Database Search Tool (Selection from Catalogue dialog)
Prerequisites
• Open the Database Search Tool - Opening the Database Search Tool
Procedure
1. Browse to the Catalogue that the item(s) your require are in.
You can use the + sign to expands the tree to show all the available catalogues and the -
sign to close branches of the tree.
2. Specify the date range that you want to filter by. You can specify any of the following:
• Modified Before
• Modified After
• Created Before
• Created After

October 2020
Database Functions
Tip
You can specify combinations of Modified/Created Before/After dates to narrow
your search results down.
3. Ensure that any date range that you have specified has a selection mark against it in the
right-hand column.
4. Specify the custom name or name that you want to filter by.
You can enter full or partial text strings in to the field. For example typing “sol” in the
name field when searching for components will return Convection Solid, Radiation
Solid, Solenoid, and Solid Bar components. Typing “solenoid” in the name field will
only return the Solenoid component.
5. Ensure that any name criteria that you have specified has a selection mark against it in
the right-hand column.
6. Specify the version number of the item that you want to filter by.
7. Ensure that the version number field has a selection mark against it in the right-hand
column.
8. Run the search by selecting either:
• Filter for Selected Catalogue Only
• Filter for Selected Catalogue and Sub-Catalogues
• Filter All Catalogues
and clicking the Refresh button.
Results
The results of the search are displayed in the Filtered Items pane. You can, if required, make
further refinements to your search criteria and by clicking Refresh see the results.
You can view the properties of any item in the filtered Items pane by selecting it. The Properties
are displayed in the bottom, right-hand pane.
Tip
If you are using the Database Search Tool to find a curve, surface or performance data you
can choose and item by clicking the Select button. The item is then added to your
component in the components data table.
If you are using the Database Search Tool to find a component you can select it by clicking the
Select button. The item is then selected ready for inclusion in your network.

October 2020
Database Functions
Related Topics
Using the Database Search Tool - Data Item Specific Search Terms
Using the Database Search Tool - Data Item Specific

Search Terms
The filter properties available in the Database Search Tool vary depending upon which database
items you are searching for.
Analytical Model Filter Properties

• Model Type - Choose from All Types, Physical Component, Component Template, or
Node.
• Number of Arms - Enter a number to return items with that number of arms only.
• Model Name Contains - Text string.
• Historic Analysis Ref. - Numerical value.
Component Filter Properties

• Number of Arms - Enter a number to return items with that number of arms only.
• Component Name Contains - Text string.
• Component Type - Choose from All Types, Physical Component, Component
Template, or Node.
• Component Status - Choose from Undefined, Simcenter Flomaster Supplied,
Production, or Prototype.
• Custom Name Contains - Text string.
• Modified Before/After Created Before/After - Date field.
Materials Filter Properties

• Name Contains - Text string.
• Material Type - Choose from All Types, Gas, Liquid, Solid, AC Fluids, or Humid Air.
• Version Number - Numerical value.
• Status - Choose from Undefined, Simcenter Flomaster Supplied, Production, or
Prototype.

October 2020
Database Functions
Material Templates Filter Properties

• Model Name Contains - Text string.
• Component Status - Choose from Undefined, Simcenter Flomaster Supplied,
Production, or Prototype.
• Fluid Type - Choose from -1 All Types, 19 Gas, 4 Liquid, 20 Solid, 21 AC Fluids, or 23
Humid Air.
Performance Data Filter Properties

• Data Type - Choose from 2D Equations, 3D Equations, All 2D Types, All 3D Types,
All Types, Curves, Pump Curves, or Surfaces.
• Title Contains - Text string.
• X, Y, Z Label Contains - Text string.
• X, Y, Z Unit - Click the [...] button and choose a unit from the Unit Quantity Selector
dialog box.
Script Filter Properties

• Script Language - Choose from All Types, C#, VB.NET, VB Script, or Java Script.
• Script Category - Choose From all Types, Network Specific, Generic,
Simcenter Flomaster Generic, Initialisation Script, Post Script, or Structured Data.
• Script Title Contains - Text string.
Symbols Filter Properties

• Symbol Name Contains - Text string.
Related Topics
Using the Database Search Tool - General

October 2020
Database Functions
Shrinking a Database
Shrinking a Database
You can reduce the size of your database to reduce the resource requirements on your system.
Before you shrink a database or file consider the following:
• A shrink operation is most effective after an operation that creates lots of unused space,
such as a 'truncate table' or a 'drop table' operation.
• Most databases require some free space for regular day-to-day operations. If you shrink
a database repeatedly and notice that the database size grows again, this indicates that
the space that was shrunk is required for regular operations. In these cases, repeatedly
shrinking the database is a wasted operation.
• A shrink operation does not preserve the fragmentation state of indexes in the database,
and generally increases fragmentation to a degree. For example, you should not shrink a
database or data file after rebuilding indexes. This is another reason not to repeatedly
shrink the database.
Using SQL Server Management Studio to Shrink the Database. . . . . . . . . . . . . . . . . . . 806
Using SQL Server Management Studio to Shrink

the Database
You can shrink the size of your database using SQL Server Management Studio.
In SQL Server 2005, each file within a database can be reduced to remove unused pages.
Although the Database Engine will reuse space effectively, there are times when a file no longer
needs to be as large as it once was; shrinking the file may then become necessary. Both data and
transaction log files can be reduced, or shrunk. The database files can be shrunk manually,
either as a group or individually, or the database can be set to shrink automatically at specified
intervals.
Procedure
1. With the SQL Server Management Studio open, right-click on the database you want to
shrink and select the option shown below:
The Shrink Database dialog box opens.

October 2020
Database Functions
Shrinking the Database Files
Figure 40-2. The Database Menu
The following details appear in the dialog box:

a. Database - Displays the name of the selected database.
b. Current allocated space - Displays the total used and unused space for the selected
database.
c. Available free space - Displays the sum of free space in the log and data files of the
selected database.
d. Reorganize files before releasing unused space - Selecting this option is
equivalent to executing the DBCC SHRINKDATABASE function and specifying a
target percentage value. If you elect not to use this option, then you are effectively
executing a DBCC SHRINKDATABASE command with the TRUNCATEONLY
option set. By default, this option is not selected when the dialog box is opened.
If you select this option, then you must specify a target percent value (see below).
e. Maximum free space in files after shrinking - Enter the maximum percentage of
free space to be left in the database files, after the database has been shrunk.
Permissible values are between 0 and 99.
2. After making your selections, click OK to close the dialog box and follow any on screen
instructions.

Instead of shrinking the database you can shrink the individual files.

October 2020
Database Functions
Procedure
1. With the SQL Server Management Studio open, right-click on the database you want to
shrink and select the option shown below:
Figure 40-3. The Database Files Menu
The Shrink Files dialog box displays as shown:

Figure 40-4. Shrink Files Dialog Box
The dialog box display the following details:

• Database - Displays the name of the selected database.
• File type - Use the dropdown list to select the file type. The available choices are
Data and Log files. The default selection is Data.

October 2020
Database Functions
Restoring a Database
• Filegroup - Click the dropdown list to choose a filegroup from the list of Filegroups
associated with the selected file type. Selecting a different filegroup changes the
selections in the other fields accordingly. The default is 'PRIMARY'.
• File name - Use the dropdown list to choose a file from the list of available files for
the selected file type and filegroup.
• Location - Displays the full path to the currently selected file. The path is not
editable, but it can be copied to the clipboard.
• Currently allocated space - For data files, it displays the current allocated space.
For log files, it displays the current allocated space computed from the output of
DBCC SQLPERF(LOGSPACE).
• Available free space - For data files, it displays the current available free space
computed from the output of DBCC SHOWFILESTATS(fileid). For log files, it
displays the current available free space computed from the output of DBCC
SQLPERF(LOGSPACE).
• Release unused space - Selecting this option causes any unused space in the files to
be released to the operating system. It also shrinks the file to the last allocated extent,
reducing the file size without moving any data. No attempt is made to relocate rows
to unallocated pages.
• Reorganize pages before releasing unused space - When this option is selected,
you must specify a target file size in the 'Shrink file to' box.
• Shrink file to - Use this option to specify the target file size for the shrink operation.
The size cannot be less than the current allocated space or more than the total extents
allocated to the file. Entering a value beyond the minimum or the maximum will
revert to the min or the max once the focus is changed, or when any of the buttons on
the toolbar are clicked.
• Empty file by migrating the data to other files in the same filegroup - Use this
option to migrate all data from the specified file to another file.
2. Select the required Shrink action and click OK.
Restoring a Database
Restore your database from backup using SQL Server Management Studio.
Procedure
1. Open SQL Server Management Studio Express.

October 2020
Database Functions
Database Recovery Options
2. Right-click on the database you want to restore and select the option shown below:
Figure 40-5. The Database Files Menu
The Restore Database dialog box opens. The dialog box has two pages, the General and
Options pages. Each page allows you to perform a range of functions relating to
restoring your data
Database Recovery Options

The Database form is used to determine the type of database backup that you want to perform.
Access the dialog box from Tools > Options
Figure 40-6. Database Recovery - The Options Dialog Box

October 2020
Database Functions
Setting the Directory Paths
The form displays the following database details:
Database size limit - this box shows the limit that the database can grow to. Details about the
current size of the database and the log file are displayed in the bottom, right-hand corner of the
Simcenter Flomaster interface, as shown below:
Figure 40-7. Database Recovery - The Status Bar
Warning flag displayed at - when the size of the database reaches the limit shown, then a
warning flag is displayed in the 'Size' box.
Simulations aborted at - when the size of the database reaches the limit shown, then you will
no longer be able to perform any simulations.
You can select Simple or Full recovery options.
Click Apply
When you do this, the Mode of Recovery flag is set in the database.
For more complete details about the Simple Recovery or the Full Recovery models see http://
msdn.microsoft.com/en-us/library/ms190388.aspx
and
http://msdn.microsoft.com/en-us/library/ms190710.aspx
Setting the Directory Paths

This option enables you to set the directory paths where CAM and Data Wizard dlls and the
files associated with the pack/unpack functionality are unpacked to.
Procedure
1. Specify the CAM and Data Wizard DLL path:
a. From the Tools menu select Options to display the Options dialog box
b. Select the Paths tab
c. Select either the Flomaster Program or Application Data directory.
d. Click the Apply button to save the changes and then the OK button to close the
Options dialog box
2. Specify the default options to be used when un-packing the file:
a. From the Tools menu select Options to display the Options dialog box

October 2020
Database Functions
Using the Database Reporting Utility
b. Select the Paths tab

c. To specify that, when unpacking, Simcenter Flomaster uses the pack file's path
hierarchy choose the Use packed hierarchy by default option. To specify that
Simcenter Flomaster displays a notification when unpacking using the packed
hierarchy, choose the Show notification when using packed hierarchy option
d. Click the Apply button to save the changes and then the OK button to close the
Options dialog box
With the Show notification when using packed hierarchy option selected the following
is displayed when unpacking a pack file:

The Database Reporting Utility enables you to inspect the projects and networks on your system
and see how much space they are occupying.
Procedure
1. Select Utilities > Database Space Reporting Utility... from the Tools menu.
The Database Space Report dialog box opens. The dialog box has three tabbed forms:
• Explorer - shows an overall view of the projects and their associated networks. The
right-hand pane shows a breakdown of each network, showing the size in MBytes
and % totals.
• Results - shows selected results for each selected network together with their
percentage values.
• Networks - shows a more detailed view of the networks.
2. To see hints about using the dialog box, click the Hints button. You can keep the dialog
box open while you are browsing for a network, or a set of results that you want to pack.

October 2020
Database Functions
Clicking the Re-open button refreshes the view and displays the new space utilization
values.
3. By using the Colour code threshold option, you can 'screen-out' those networks that are
below a certain size. Using the example shown above, if the value is set to 20, then only
those networks above the threshold are highlighted.

October 2020
Database Functions
Hybrid Results
Hybrid Results
Hybrid results sets are those that are stored locally, rather than checked-in to the Simcenter
Flomaster database. Saving Simulation results in this way can save database space and, in
situations where a slow network or high network latency is an issue, can reduce the time it takes
for simulations to run. You can choose to check-in any Result Sets that were created as Hybrids
to the Simcenter Flomaster database.
You can tell which Result Sets are hybrid from the Result Set/Audit tab in the Network View
pane.
• Indicates the results have been stored in the database.
• Indicates the results have been stored locally.
Figure 40-8. Hybrid Results - The Results Set/Audit Tab
Note
Like checked-in Result Sets, you can pack Hybrid Result Sets along with the Network (see
“Pack and Unpack” on page 455) but these will be automatically added to the Database as
part of the pack process. Because of this, all unpacked Result Sets will show a status of
checked-in.

Checking Result Sets In and Out of the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Storing Hybrid Results

You can specify that any Result Sets created during simulations are stored locally, as Hybrid
Results, rather than in the Simcenter Flomaster database.
Procedure
1. Choose Options from the Tools menu.
The Options dialog opens.
2. Click the Hybrid Results tab.
3. Select the Write Hybrid Result and then click Result Path.

October 2020
Database Functions
Checking Result Sets In and Out of the Database
4. Browse to the place you want to store the results and click OK.
5. Click Apply then OK.

You check Result Sets that were created as Hybrid Results into the Simcenter Flomaster
database and you can check Result Sets out of the Simcenter Flomaster database to a local file
location.
Procedure
1. Select the Result Sets/Audi tab in the Network View pane.
2. Select the result set or sets that you want to check in or check out then choose either:
Check-in Hybrid Result or Check out Hybrid Result.
Note
The choice available to you will depend upon the Result Set that you chose in step 1.

October 2020
Database Functions

October 2020
Chapter 41
FlowmasterLink for MATLAB Simulink
FlowmasterLink for Simulink allows co-simulations to be performed between a Simulink

models and Simcenter Flomaster.
S-Functions in Simulink1are used to describe a dynamic system, i.e. a system that consists of
inputs, outputs, and states.
S-functions are treated as transfer functions - they provide an input to the transfer function and
the 'r;states' perform the commanded task before returning an output. The remaining Simulink
model continues with the received output result.
In the case of FlowmasterLink for Simulink, the S-Function performs data exchange between a
dynamical model in Simulink and a fluid or/and electromechanical model in
Simcenter Flomaster
Note
FlowmasterLink for Simulink requires a separate license. During model configuration and
run-time each FlowmasterLink for Simulink S-Function requires a FlowmasterLink for
Simulink license and Simcenter Flomaster license.
FlowmasterLink for Simulink - The Co-simulation Process . . . . . . . . . . . . . . . . . . . . . . 818

FlowmasterLink for Simulink - Setting Up The Connections . . . . . . . . . . . . . . . . . . . . . 819
FlowmasterLink for Simulink - Defining the Simcenter Flomaster Network . . . . . . . . 821
FlowmasterLink for Simulink - Specifying the Simcenter Flomaster Simulation Data 823
FlowmasterLink for Simulink - Setting Up and Running Co-simulations. . . . . . . . . . . 826
FlowmasterLink for Simulink - Running a Co-simulation . . . . . . . . . . . . . . . . . . . . . . . . . 827
FlowmasterLink for Simulink - Common Errors and Issues . . . . . . . . . . . . . . . . . . . . . . . 827
FlowmasterLink for Simulink - Example 1: A Simple Co-simulation . . . . . . . . . . . . . . . . 830
FlowmasterLink for Simulink - Example 2: Co-simulation Using Macros . . . . . . . . . . . . 832
836
1. MATLAB® and Simulink® are MathWorks® products.

October 2020
FlowmasterLink for Simulink - The Co-simulation Process
FlowmasterLink for Simulink - The Co-

simulation Process
FlowmasterLink for Simulink enables you to configure connection to the Simcenter Flomaster
database, specify the Simcenter Flomaster model, map components, and specify the simulation
conditions.
You can use it to:
• Specify which Goto & From blocks in the Simulink model need to pass and receive data
during the co-simulation (as well as the Controllers and Gauges in Simcenter Flomaster
that will do the same).
• Configure the S-function with the corresponding database and network information.
The Goto & From blocks can then be mapped to the respective Controllers and Gauges
(which is done automatically if they share the same name).
Once configured, running a Simulink model with the S-functions active will initiate the
Simcenter Flomaster network simulations and perform co-simulation by automatically
transferring appropriate variables between the two programs.
The input variables set in Simulink, at each/specified time step, are transferred (using Goto
block) via the S-function (Simcenter Flomaster Interface block) to the Simcenter Flomaster
COM controller(s). The Simcenter Flomaster network then uses the incoming variable data in
its analysis. The output variable is transported from the Simcenter Flomaster model via a gauge
to the Simulink 'r;From' block, which is then used by the Simulink model.
Once configured, running a Simulink model with the S-functions active will initiate the
Simcenter Flomaster network simulations and perform co-simulation by automatically
transferring appropriate variables between the two programs.
The input variables set in Simulink, at each/specified time step are transferred (using Goto
block) via the S-function (Simcenter Flomaster Interface block) to the Simcenter Flomaster
controller(s). The Simcenter Flomaster network then uses the incoming variable data in its
analysis. The output variable is transported from the Simcenter Flomaster model via a gauge to
the Simulink ‘From’ block, which is then used by the Simulink model.
Running a co-simulation consists of the following steps:
1. Create a Simulink model and validate.

2. Create a Simcenter Flomaster network containing components to represent the
connections in the Simulink model. Validate the network.
3. Configure the Simulink model using the Simcenter Flomaster Interface.
4. Run co-simulation until convergence is achieved.

October 2020
FlowmasterLink for Simulink - Setting Up The Connections
FlowmasterLink for Simulink - Setting Up The

Connections
To perform a Simulink – Simcenter Flomaster co-simulation you must enable the Simcenter
Flomaster network to communicate with Simulink.
This is done via the Simcenter Flomaster Interface S-Function (the code representation of a
Simulink block) which you set up as a Simcenter Flomaster Link for Simulink client.
Prerequisites
• A suitable Simcenter Flomaster network with a Controller and Gauge components
Note
The instructions below relate to actions performed in Simcenter Flomaster.
Procedure
1. Set the Controller's Algorithm Type to 4.
The Goto block is used to pass input variables from Simulink (via the Simcenter
Flomaster Interface block) to Simcenter Flomaster. This provides an input signal for the
Simcenter Flomaster Controller.
All other data items can be set to represent the physical variable input.
Table 41-1. Example of Controller Input Parameters for Simulink – Simcenter

Flomaster Co-simulation
Property Value
Type Controller Template
Title Heat_Input_1
Algorithm Type 4
Output Quantity 52 Heat Flow Rate
Output Initial Value 10000<kW>
Output Clipping - Min Value 0 <kW>
Output Clipping - Max Value 10000 <kW>
2. Set the Tag visibility in the Goto block parameters to global.

October 2020
FlowmasterLink for Simulink - Setting Up The Connections
Figure 41-1. The Simcenter Block Parameters: Goto Dialog Box
Note
You should ensure that the Goto parameters tag corresponds to a specific input
connection on the Controller component.
3. Set the Gauge's Algorithm Type to 4.

The From block is used pass signals from the Simcenter Flomaster Gauge component
(via the Simcenter Flomaster Interface block) to Simulink.
All other data items can be set to represent the physical variable outputs.
Table 41-2. Example of Gauge Input Parameters for Simulink – Simcenter

Flomaster Co-simulation
Type: Controller Template Value
Type Gauge Template
Title: Heat_Input_1 Coolant_Temp
Algorithm Type 4

October 2020
FlowmasterLink for Simulink - Defining the Simcenter Flomaster Network
Table 41-2. Example of Gauge Input Parameters for Simulink – Simcenter

Flomaster Co-simulation (cont.)
Type: Controller Template Value
Output Quantity 36 Temperature
Output Initial Value 20 <deg C>
Output Clipping - Min Value 0 <deg C>
Output Clipping - Max Value 500 <deg C>
4. Ensure that the Title for the Controller and Gauge components match those for the
Simulink tag.
a. Double-click the Controller component.
b. Ensure that the mode is set to Results in the lower section of the Network View
pane.
c. In the Controller Template field, click the [...] button.
The Controller Template sub form opens.
d. Enter a title in the Title field to match that of the Simulink Goto tag.
e. Double-click the Gauge component.
f. Ensure that the mode is set to Results in the lower section of the Network View
pane.
g. In the Gauge Template field, click the [...] button.
The Gauge Template sub form opens.
h. Enter a title in the Title field to match that of the Simulink From tag.
FlowmasterLink for Simulink - Defining the

Simcenter Flomaster Network
You must, from within Simulink, specify the name and location of the Simcenter Flomaster
network.
Prerequisites
which runs successfully (without errors).
• Ensure that Simcenter Flomaster has been closed.
Procedure
1. Click the S-Function icon in the Simulink model.

October 2020
FlowmasterLink for Simulink - Defining the Simcenter Flomaster Network
The FM4SL Logon dialog box opens.

Figure 41-2. The FM4SL Logon Dialog Box
2. Specify the Simcenter Flomaster user logon and Database details and click OK.
Tip
The Network information is specified in Simulink, in the Simcenter Flomaster
interface block, which you can open by double-clicking on the S-function.
A dialog box opens confirming successful logon to Simcenter Flomaster and asking you
to specify the network that you want to use.
3. Choose a network to work on.
Results
The FM4SL Data Setup dialog box is displayed.

October 2020
FlowmasterLink for Simulink - Specifying the Simcenter Flomaster Simulation Data
FlowmasterLink for Simulink - Specifying the

Simcenter Flomaster Simulation Data
You must specify the properties of any Simcenter Flomaster results created as part of the co-
simulation process and ensure that the Simcenter Flomaster data items are set correctly.
Prerequisites
which runs successfully (without errors).
• Ensure that Simcenter Flomaster has been closed.
• Define the Simcenter Flomaster network to be used (see “FlowmasterLink for Simulink
- Defining the Simcenter Flomaster Network” on page 821) - The FM4SL Data Setup
dialog box should be visible.
Procedure
1. Specify the Simulation data.
Figure 41-3. The FM4SL Data Setup dialog - Setting the Simulation Data
a. Specify the Simulation Type. You can also enter a Result Description.
The contents of the Result Description field are added to the Simcenter Flomaster
result set as the Description Field and can help you to identify specific results sets
when you have run several simulations on a network.
For more information on Simcenter Flomaster results see “Results” on page 417.

October 2020
b. Use the Component Interaction Enabled or Thermal Expansion Enabled to

specify either of these two options.
For more information on Component Interaction see “Component Interaction” on
page 587.
Note
Thermal expansion is only operational for analysis that runs with or takes into
account heat transfer.
c. Use the Segmentation Analysis Enabled option to specify whether

Simcenter Flomaster segmentation is active for the simulation.
For more information on Segmentation see “The Segmenter” on page 553.
d. Use the Sample Time options to specify the time interval for co-simulation.
Choose from either:
o Inherit Simulink (Default) - Simcenter Flomaster data exchange takes place at
all Simulink iterations.
o Auto-Adjusted Time Step for Compressible Pipes - Select this option for
Networks containing compressible pipes.
o User Specified - When selected, you can specify a time step. In this instance
Simulink will perform the co-simulation once per specified sample time.
This option is suitable when the Simcenter Flomaster network is run with a very
small time step for a long simulation time and it is acceptable for the Simulink
model to receive results at a certain time interval, rather than at all iterations.
Note
Note: If co-simulation is run from Simulink and the stop time in Simulink is less
than the Simcenter Flomaster analysis end time, the co- simulation will terminate
when the Simulink model is stopped.
If the Simcenter Flomaster analysis end time is less than the Simulink stop time then
the co-simulation will continue to run to completion.
2. Specify which start time, end time, and time step the co-simulation uses.
a. To use the Simcenter Flomaster values, leave the Simulink Simulation Parameters
check box unchecked.
b. To use values set in Flomaster Link for Simulink:
• Select the Simulink Simulation Parameters check box.
• In the Time Step field of the General Data Setup table, specify a time step value.

October 2020
• In the Simulation Start Time field of the General Data Setup table, specify a start
time.
• In the Simulation End Time field of the General Data Setup table, specify an end
time
When checked, these values will override any values set on the Simcenter Flomaster
General Data tab.
If an automatic time step is generated for the Simulink simulation, Simcenter Flomaster
will use the first time-step value specified by Simulink.
Tip
Checking the Include option alongside any field will use this value for any
subsequent simulations
3. You can use the General Data Setup table to set or change Simcenter Flomaster data
items from the Flomasterlink for Simulink application.

October 2020
FlowmasterLink for Simulink - Setting Up and Running Co-simulations
FlowmasterLink for Simulink - Setting Up and

Running Co-simulations
Co-simulation can be performed from Simulink or Simcenter Flomaster.
In Simcenter Flomaster, co-simulation can be executed using two macros:
• Running the “Simcenter Flomaster Link for Simulink Setup” macro sets up the
connections, analysis type, general data etc from Simcenter Flomaster. You must set the
sMLModelPath and model name in the sMLSFuncName (see example code below).
• To perform co-simulation from Simcenter Flomaster, the “Simcenter Flomaster Link for
Simulink Run” macro is required. Prior to execution of the script insert the correct path
in the sMLModelPath.
Examples of the VB script macros are provided. Modify the file paths to the locations of your
specific files.
Simcenter Flomaster Link for Simulink Setup:
--------------------Start of Macro code----------------------------------

'Simcenter Flomaster Link for Simulink Setup’ [Save this Macro as VB
script]
sMLModelPath=”C:\Users\Product Manager\My Documents\MATLAB\
SIMULINK_tutorial_one.mdl"
sMLSFuncName="SIMULINK_Tutorial_One/Simcenter Flomaster Interface"
Set ml = CreateObject ("FlowmasterSimulink")
ret=ml.ShowDialog(1,sMLModelPath,sMLSFuncName,"","","")
-----------------------------End of Macro code---------------------------
Simcenter Flomaster Link for Simulink Run
-------------------------Start of Macro code----------------------------

'Simcenter Flomaster Link for Simulink Run’ [Save this Macro as VB script]
sMLModelPath= “C:\Users\Product Manager\My Documents\MATLAB\
SIMULINK_tutorial_one.mdl"
Set MATLAB=CreateObject("MATLAB.Application")
MATLAB.Execute("open('"+sMLModelPath+"')")MATLAB.Execute("set_param(gcs,
'SimulationCommand', 'start')")
Do
simstat=MATLAB.Execute("get_param(gcs,'SimulationStatus')")
Loop While Mid(simstat,9,7)<>"stopped"

------------------------End of Macro code--------------------------------
• Ensure the correct path is entered in the sMLModelPath

• Check for the correct model name in the sMLSFuncName
• Do not make changes to the text “Simcenter Flomaster Interface”
FlowmasterLink for Simulink - Running a Co-simulation . . . . . . . . . . . . . . . . . . . . . . . 827

October 2020
FlowmasterLink for Simulink - Running a Co-simulation
FlowmasterLink for Simulink - Common Errors and Issues . . . . . . . . . . . . . . . . . . . . . 827

FlowmasterLink for Simulink - Example 1: A Simple Co-simulation . . . . . . . . . . . . . . 830
FlowmasterLink for Simulink - Example 2: Co-simulation Using Macros . . . . . . . . . . 832
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
FlowmasterLink for Simulink - Running a Co-

simulation
Once you have created the Simcenter Flomaster Link for Simulink Setup and Simcenter
Flomaster Link for Simulink Run macros you can run the co-simulation.
Prerequisites
• Create and save the Simcenter Flomaster Link for Simulink Setup and Simcenter
Flomaster Link for Simulink Run macros (see “FlowmasterLink for Simulink - Setting
Up and Running Co-simulations” on page 826).
Procedure
1. From Simcenter Flomaster’s Project View, navigate to the saved Simcenter Flomaster
Link for Simulink Setup macro (typically saved in Scripts > User-defined) and double-
click it to start the process.
The FM4SL Logon dialog box opens.
2. Ensure that the Logon and database details are correct.
See “FlowmasterLink for Simulink - Defining the Simcenter Flomaster Network” on
page 821.
3. From Simcenter Flomaster’s Project View, navigate to the saved Flomaster Link for
Simulink Run macro (typically saved in Scripts > User-defined) and double-click it.
The Simulink model will open and automatically co-simulate with the
Simcenter Flomaster network using the last saved parameters.
FlowmasterLink for Simulink - Common Errors and

Issues
Some common issues, observed while installing/running Simcenter Flomaster Link for
Simulink, and their fixes are described.

October 2020
FlowmasterLink for Simulink - Common Errors and Issues
Network with user created CAMs does not work with Simulink
If your network contains CAMs created in an earlier version of Simcenter Flomaster, co-
simulation may fail.
Solution - You must copy the Matlab.exe.config file (available in the Simcenter Flomaster
directory) into the directory where Matlab.exe is installed.
This file is usually in C:\Program Files\MATLAB\{MatlabVersion}\bin\win32 (or Win64).

October 2020
FlowmasterLink for Simulink - Common Errors and Issues
If you have existing matlab.exe.config file you can append the file with following example
code:
<?xml version="1.0" encoding="utf-8"?>

<configuration>
<startup useLegacyV2RuntimeActivationPolicy="true">
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.1"
/>
</startup>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="Flowmaster.Interfaces"
publicKeyToken="a622c4c62ff70785" culture="neutral" />
<bindingRedirect oldVersion="7.1.0.0-9.5.0.200"
newVersion="9.4.0.0" />
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="FMI.Interfaces"
publicKeyToken="0fd903bc29c97847" culture="neutral" />
<bindingRedirect oldVersion="8.0.0.0-9.4.0.0" newVersion="9.4.0.0"
/>
<dependentAssembly>
<assemblyIdentity name="Newtonsoft.Json"
publicKeyToken="30ad4fe6b2a6aeed" culture="neutral" />
<dependentAssembly>
<assemblyIdentity name="Flowmaster.DataAdapter"
publicKeyToken="a622c4c62ff70785" culture="neutral" />
</assemblyBinding>
<loadFromRemoteSources enabled="true" />
</runtime><system.runtime.caching>
<memoryCache>
<namedCaches>
<add name="fluidServicePropertiesCache"
cacheMemoryLimitMegabytes="400" pollingInterval="00:02:00" />
</namedCaches>
</memoryCache>
</system.runtime.caching>
</configuration>
----------------------------------------------------------------------
Networks fail to run in x64 Simulink

In Simcenter Flomaster 2019.2, for x64 version of operating systems, some complex networks
may fail to run.
Solution - Copy the contents of Matlab.exe.config into a new file dllhost.exe.config then copy
teh new dllhost file to C:\Windows\SysWOW64.

October 2020
FlowmasterLink for Simulink - Example 1: A Simple Co-simulation
FlowmasterLink for Simulink - Example 1: A Simple

Co-simulation
This example shows how variables can be exchanged between the Simulink model and
Figure 41-4. Example 1: Co-simulation Network
Referring to Figure 41-4, the heat quantity transferred from the Simulink model to the
Controller: 7 is then used by Simcenter Flomaster to heat-up the fluid temperature. Gauge: 8
measures the fluid temperature at node 3 and forwards the results to the Simulink model for
further use.
Procedure
1. Open Simcenter Flomaster and login.
2. Unpack and open C:\Program Files(x86)\Common Files\Simcenter\Flomaster\Tutorials
\FML4SL\Tutorial Pack Files for FM V9\Tutorial_Network_One.FMPck into the
desired project.
3. Collect Components 7 and 8 and set the Algorithm types (for both components) to 4.
4. Ensure that the Controller Output Quantity is set to 52: Heat flow rate.
5. Enter title Heat_Input_1 (if not already entered) for Controller: 7 and the title
Coolant_Temp (if not already entered) for the Gauge.
6. Run a Steady State simulation on the Network.
It should run successfully.
7. Open Simulink_tutorial_one.mdl in Simulink.

October 2020
FlowmasterLink for Simulink - Example 1: A Simple Co-simulation
Tip
To minimise the risk incompatibility issues between different versions of Simulink,
delete the supplied Flowmaster Interface block from the tutorial example and replace
it with a new Simcenter Flomaster Interface block taken from the Simulink Library
Browser.
Figure 41-5. Example 1: Co-simulation Network: The Simulink Window
8. Double-click the Simcenter Flomaster Interface S-function icon.

a. Input the information to login to the database in which the network is stored. After
supplying the correct information click OK.
b. When asked to select the network for analysis select “Tutorial Network One”.
The FM4SL Data Setup dialog box opens.
c. Check the checkboxes after Heat_Input_1 and Coolant_Temp.
Note
In general data setup do not provide any information.
d. In simulation Data Setup select Simulink Simulation Parameters.

e. Select the radio button Inherit Simulink in Simulation Data Setup.
f. Select Heat Transfer Transient as the analysis type.

October 2020
FlowmasterLink for Simulink - Example 2: Co-simulation Using Macros
9. In Simulink, set the Stop time as 40s, Solver options as Fixed-step, Fixed step size as
0.1
10. Click Start Simulation.
Results
Once the simulation has finished, you will see the co-simulation results in the Simulink model
as below:
Figure 41-6. Example 1: Co-simulation Network: Results
FlowmasterLink for Simulink - Example 2: Co-

simulation Using Macros
This example shows how variables can be exchanged between a Simulink model and multiple
Simcenter Flomaster networks by using multiple Simcenter Flomaster Interface blocks in a
Simulink model.

October 2020

• This exercise requires a Simcenter Flomaster MBD: Co-Simulation in conjunction with
another capable license for each Simcenter Flomaster Interface block used.
Prerequisites
• Example Start up and Run macros are given in “FlowmasterLink for Simulink - Setting
Up and Running Co-simulations” on page 826.
Procedure
1. Open Tutorial_Network_One and run it with Heat Transfer Steady State
2. Unpack Tutorial_Network_Two network in the Simcenter Flomaster project and run
with Heat Transfer Steady State.
Figure 41-7. Example 2: Co-simulation Network
3. For Controllers 30, 38, 40, and 44:

a. Set the Algorithm Type as None.
b. Set the Input-Output Quantities, Output Initial value, and Output Clipping Min and
Max values according to their parameters.
c. Set the <30> Controller Title to Vehicle_speed
d. Set the <38> Controller Title to Engine_Heat_W
e. Set the <40> Controller Title to Pump_speed
f. Set the <44> Controller Title to Vehicle_speed_2
4. Open Simulink_Tutorial_Two in Simulink.

October 2020
Tip
To minimise the risk of compatibility issues between different versions of Simulink,
delete the supplied Flowmaster Interface blocks and replace them with a new
Simcenter Flomaster Interface blocks taken from the Simulink Library Browser.
5. Double-click the FM Interface One icon.

Simcenter Flomaster Logon dialog box opens.
6. Select the appropriate logon details and select network “Tutorial_Network_Two” in the
Simcenter Flomaster project then click OK.
The FM4SL Data Setup dialog box opens.
7. Set the MATLAB to Simcenter Flomaster connections and Simcenter Flomaster to
MATLAB connections as shown below:
Figure 41-8. Example 2: Connections
8. Set the Analysis Type to Heat Transfer Transient.

9. Check Simulink Simulation parameters option.
10. Click OK to save the settings

October 2020
11. Open FM Interface two and select Project: Simcenter Flomaster and Network:
Tutorial_Network_One in the Model tab.
12. Set the MATLAB to Simcenter Flomaster connections as
Heat_Input_1 ~ Heat_Input_1 and the Simcenter Flomaster to MATLAB connections
as Coolant_Temp ~ Coolant_Temp
13. Set the Analysis Type to Heat Transfer Transient, select the Simulink Simulation
Parameters option and click OK to save the settings.
14. From Simulink’s Configuration Simulation Parameters section verify the following
settings:
a. Start Time: 0.0
b. Stop Time: 300
c. Type: Fixed-step Fixed step size: 2
15. Click Start Simulation in the Simulink model.

October 2020
Results
You should now see the following co-simulation results in scopes 1 and 3 respectively:
Figure 41-9. Example 2: Results
FlowmasterLink for Simulink - Example 3: Reading

Co-simulation Concentration Results
This example shows how to view the co-simulation node concentration results in Simulink.

October 2020
On this example the following Simcenter Flomaster network is considered:
Figure 41-10. Example 3: The Simcenter Flomaster Network
Set up the co-simulation in the usual way (see “FlowmasterLink for Simulink - Example 1: A
Simple Co-simulation” on page 830 and “FlowmasterLink for Simulink - Example 2: Co-
simulation Using Macros” on page 832), with controllers and gauges connecting to the relevant
inputs.
Nodes 1 and 2 have their concentration set by the corresponding upstream Flow Sources, and
are a mixture of Nitrogen, Oxygen, and Carbon Dioxide. These two streams each pass through a
Fluid Modifier to change their composition before flowing through Node 3 and into the Pressure
Source.
Based on this each gauge should receive 3 concentration values – 1 for each fluid present in the
mixture.

October 2020
A Simulink model can be built to extract these values for use in Simulink, for example:
Figure 41-11. Example 3: The Simulink Network
Note
The Tag names for the From blocks include information about the size of the signal they are
expecting to receive. The number of concentration values that are expected have been put in
between two underscores at the end of the tag name. These numbers are read by the
Simcenter Flomaster to set signal dimensions before the simulation starts.
The simulation can then be setup and run in the usual manner. Once complete the concentration
results for all fluids read by that gauge are output as the signal.
Note
The concentration results are output in the same order as they are output when viewing
concentration results through Simcenter Flomaster.

October 2020
Chapter 42
Co-simulation
You can create Functional Mock-up Interface (FMU) packages which contain the FMI
(Functional Mock-up Interface) compliant files required to perform co-simulation between
Simcenter Flomaster and a range of other modeling products.
By exporting FMU packages and using the Simcenter Flomaster supplied Co-simulation
boundaries, you can use Simcenter Flomaster simulation data in any FMI Master Capable
(master) program.
For Simcenter Flomaster simulations to be FMI compliant, you must have input and output
blocks that you can map to the corresponding signals in the master program. You do this by
adding co-simulation boundary components (which function as a controller would) to your
network. When exported as part of a Simcenter Flomaster FMU export file, these pass inputs to
the network and pick out the outputs for communication to the master program.
Adding Co-simulation Boundary Components to your Network . . . . . . . . . . . . . . . . . . 839

Creating a Simcenter Flomaster FMU Export File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
Creating an FMU for Model Exchange Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
Adding Co-simulation Boundary Components

to your Network
You must add at least one Co-Simulation Input and one Co-Simulation Output boundary
component to your network.
Figure 42-1. Co-simulation Boundaries Example Network

October 2020
Co-simulation
Creating a Simcenter Flomaster FMU Export File
Creating a Simcenter Flomaster FMU Export

File
To perform a co-simulation you must import an FMU file into the FMI Master Capable
program. This procedure documents the creation of the Simcenter Flomaster FMU.
Prerequisites
• A Simcenter Flomaster network containing at least one Co-simulation Input Boundary
component and one Co-simulation Output Boundary component.
Procedure
1. With the Network open in the Network drawing window select FMU Export from the
File > Export menu.
The FMU Export dilaog opens.
The co-simulation boundary input and export parameters are displayed in the top pane of
the dialog box. You can use the headers of the columns to sort and filter the parameters.
The FMU settings are displayed in the bottom pane.
2. You can modify the FMU settings:
a. To add an image (which will be visible in the Master Capable program) to the export
package, click the ... button next to the image field and use the Choose a picture
dialog box to choose a picture.
Note
If you choose not to add a picture, the default image, , is used.
b. You can specify the path that the FMU file is exported to by clicking the ... button
next to the path field and borwsing to a suitable location.
3. Click the Export button to export the file.
4. Click the Close button to close the FMU Export dialog box.
Creating an FMU for Model Exchange Import

For co-simulation applications, you can import an FMU that can then act as a controller and
provide output signals to the rest of the network.
• The FMU that you want to import must meet V2 of the FMI Standard, be created as an
FMU for model exchange, and include a Win32 compiled model.

October 2020
Co-simulation
Procedure
1. From the Component group on the Launchpad click the New FMU Component link.
The N-Arm Component Wizard dialog box opens.
The Select FMU File dialog box opens.

3. Navigate to the FMU file that you want to import. Select it and click Open.
Note
Boolean and text inputs and outputs are not supported and are ignored on import. In
this instance a warning message will be displayed in the IMPORT PROGRESS
window.
The FMU is imported into Simcenter Flomaster. Any import errors or warnings will be
displayed in the IMPORT PROGRESS window.
Simcenter Flomaster switches to the Project View with the Catalogues tab open. The
new component, which is created in the Components > User-defined catalogue, is
selected and the Component Customisation Form is open.
5. Use the Component Customisation Form to set the inputs, real and fixed parameters, and
outputs.
The FMU can have:
• Up to 20 variable inputs
These are mapped to controller output signals and correspond to the tuneable
parameters and the discrete and continuous input parameters in the FMI
specification.
• Up to 20 Real and 5 Integer Fixed parameters
These correspond to the fixed parameters in the FMI specification.
• Up to 40 outputs plus local outputs
These correspond to the constant output, discrete output, and continuous output in
the FMI specification.
For more information on setting the component properties above see “Customizing
Components” on page 268.

October 2020
Co-simulation
Results
You can now use the new component as a controller in a transient Simcenter Flomaster
network.

October 2020
Chapter 43
Automation in Simcenter Flomaster
Simcenter Flomaster supports extensive GUI automation (GUI and Analysis Automation).
GUI Automation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Analysis Automation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Automation - Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
How COM is Implemented . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
GUI Automation
Based on Microsoft's Component Object Model (COM) as a simple set of hierarchical classes,
these functions provide access to all the major GUI functions. .
For example, the Command Line functions allow you to create projects and networks, use
FMDNA, create and run batch jobs and print results, etc
Other functions, such as those in the Project class, allow you to access to networks and to
database items owned by a particular project. Functions in the network class allow access to
components and nodes within the network and to result sets that have been produced by the
network.
To understand COM, it is important to bear in mind that COM is not an object-oriented-

language, but a standard. COM does not specify how an application should be structured; the
language, structure and implementation are left to you the programmer. What COM does
however is to specify the object model and the programming requirements that enable COM
objects to interact with other objects.
These objects can be within a single process (e.g. Simcenter Flomaster), in other processes, or
on a remote machine. They can be written in different languages and can be structurally
different from one another. This is why COM is referred to as a 'r;binary standard' - it is a
standard that applies only after a program has been translated into binary machine code.
The only language requirement for COM is that the code is generated in a language that can
create structures of pointers, that either explicitly or implicitly call functions through these
pointers.
COM defines the essential nature of a COM object. In general, a software object is made up of a
set of data and the functions that manipulate the data. A COM object is one in which access to
an object's data is achieved exclusively through one or more sets of related functions. These
functions are called interfaces, and the functions of an interface are called methods. Further,

October 2020
GUI Automation
COM requires that the only way to gain access to the methods of an interface is through a
pointer to the interface.
Besides specifying the basic binary object standard, COM also defines certain basic interfaces
that provide functions common to all COM based technologies. It also provides a small number
of API functions that all components require.
GUI Automation Functions

The GUI Automation functions are based on a simple set of hierarchical classes. These classes
and their interfaces are defined in a type library ('Flowmaster.Automation.Gui.tlb') file which is
shipped with Simcenter Flomaster. All necessary declarations are automatically made in the
registry when the Simcenter Flomaster program starts up.
The CommandLine class provides the same basic functionality as the Simcenter Flomaster
command line interface, version
6.5. These commands still provide the best way of using Simcenter Flomaster to perform simple
network update and analysis tasks with minimal programming.
Client applications must only directly create Application and CommandLine objects. Lower
level class objects must generally be created using methods provided by the parent class. Care
should be taken not to delete parent objects before their child objects are deleted. The following
Visual Basic code illustrates how the hierarchical class structure may be navigated - every result
set, of every network of every project is opened and closed.

October 2020
Analysis Automation
Dim fmApp As Flowmaster_Automation_Gui.Application Dim project As

Flowmaster_Automation_Gui.Project Dim network As
Flowmaster_Automation_Gui.Network Dim result As
Flowmaster_Automation_Gui.ResultSet
Dim projectName,networkName,resultID As Variant
Set fmApp = New Flowmaster_Automation_Gui.Application

For Each projectName In fmApp.ProjectNames
Set project = fmApp.Project(projectName)
If (project Is Nothing) = False Then
For Each networkName In project.networkNames
Set network = project.network(networkName)
If (network Is Nothing) = False Then
For Each resultID In network.ResultSetIDs
Set result = network.ResultSet(resultID)
If (result Is Nothing) = False Then
' Do something with result set !
Set result = Nothing
End If
Next resultID
Set network = Nothing
End If
Next networkName
Set project = Nothing
End If
Next projectName
GUI Automation Classes

You can automate the Simcenter Flomaster GUI behavior based on the type of application class.
The following classes are supported.
• Project Class
• Network Class
• Component Class
• Node Class
• Result Set Class
• Database Class
Analysis Automation
The Analysis Automation functions allow you to access to the analysis while it is running. For
example, using the Management functions allow external programs to initialize and control the

October 2020
Automation - Application
progress of a Simcenter Flomaster analysis. Using the Controller functions in conjunction with
the COM controllers allow you to set the speed of a pump or the position of a valve, while using
the Gauge functions in conjunction with the COM enabled gauges allows key variables, such as
pump speed or valve position, etc, to be displayed.
Automation - Application
In application terms, COM enables other applications to start Simcenter Flomaster remotely and
perform most tasks that can be performed using the Simcenter Flomaster GUI, in a
programmatical way. For example, it is possible to start Simcenter Flomaster, open a project,
open a network, edit some data, run an analysis an then inspect and manipulate the results.
This Command Line Interface functionality is available to any program which can access the
functions described in this on-line document. This third party program need have no knowledge
of the internal workings of Simcenter Flomaster and can access it using scripts written in Basic,
C++ or JavaScript. It is also possible to access Simcenter Flomaster in such a way from
applications such as Microsoft Word, Excel or Access, all of which support Visual Basic for
Applications (VBA).
How COM is Implemented

COM is implemented by the controller and gauge template components when connected to
components such as pumps and valves. You can also use scripts to tailor these components to
perform specific functions and use them to link to external applications.
When you start an analysis, the COM objects are constructed to represent all the controllers and
gauges in the network. The interfaces to these objects allow other COM enabled applications to
manipulate or acquire data from these objects.
COM objects can be manipulated using scripts. You can embed a control algorithm written in
VBScript or JScript - into the controller or gauge template. These scripts are then able to use the
COM interfaces of the gauges and controllers within the network to communicate with external
applications.

October 2020
Chapter 44
Command Line Utilities
The command line utilities are a number of XML based functions that can be invoked from the
command line.
They are intended to allow some operations in Simcenter Flomaster to be controlled by another
program, but they can be used manually to:
1. Create a batch file.

2. Use the Electronic Data Interchange Facility (EDIF) to create an EDIF file that contains
all the component, node and general simulation data. Having done this, you can then
attach the EDIF file to the batch process and run it. This has the effect of setting all the
component, node and general simulation data in a Simcenter Flomaster network, and
running a simulation automatically.
3. Build a network using the Simcenter Flomaster Direct Network Assembly (FMDNA)
facility. FMDNA provides a mechanism which allows Simcenter Flomaster to
automatically create a network diagram based on a description of its components and
connectivity.
4. Create a new project
5. Delete a project and re-assign users, networks and data to a named project.
6. Add a new network to a project.
7. Delete a network
8. Pack and unpack networks.
When you use one of the above utilities to create, say a new project, Simcenter Flomaster
produces an XML input file. This XML file contains all the relevant information required to
carry out the requested function. Each XML file is validated by an associated schema when the
function is executed via the command line.
The schemas act like 'templates'. Each time a function is processed, the relevant schema
validates the XML content. It checks to see if each XML statement is complete and that there
are no errors. If any errors are found, they are reported in an errors file. For example, if you do
not enter a user name and password for the project you are logging onto, then an error will be
generated
The following schemas are provided:
• BatchFile.xsd

October 2020
Executing Command Line Functions
• CreateNetwork.xsd
• CreateProject.xsd
• DeleteNetwork.xsd
• DeleteProject.xsd
• EDIFFile.xsd
• FMDNA.xsd
• PackNetwork.xsd
• UnpackNetwork.xsd.
The schemas are located in the Simcenter Flomaster XMLSchema folder.
Executing Command Line Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848

Processing the Batch File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
Creating Batch Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
Using the 'CreateProject' Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Executing the 'CreateProject' Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Using Command Line Utilities to Create a New Network . . . . . . . . . . . . . . . . . . . . . . . . 855
Deleting a Network using the Command Line Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Executing the 'DeleteNetwork' Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Unpacking a Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Executing the 'UnpackNetwork' Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865

Any XML that you have created must be executed to run it.
Procedure
1. Type 'cmd' in the Windows Run dialog box.

October 2020
Figure 44-1 shows an example of the Command Interpreter window:

Figure 44-1. The Command Interpreter Window
2. When you enter the command string, you must be in the Simcenter Flomaster folder as
shown above.
3. Enter details about the command you want to execute and its location.
For example:
C:\Program Files (x86)\Simcenter\Flomaster\Flowmaster.CommandLine Keyword,
Arg1, Arg2, Arg3

October 2020
Processing the Batch File
Where:
Table 44-1. Command Line Arguments and Functions

If you want Do the following
to...
Keyword The name of the XML function that you want to use. The following
keywords are used:
• CreateProject - creates a project
• CreateNetwork - creates an instance of a network, but with no
components, etc
• FMDNA - populates the network created by the CreateNetwork
function with the specified components and nodes
• RunBatchSync - runs the batch process with the attached EDIF file
• DeleteProject - deletes a named project
• DeleteNetwork - deletes a named network
• PackNetwork - creates a pack file containing a named network
• UnpackNetwork - unpacks a pack file containing a named network.
Arg1 The full path name to the XML file that you want to execute.
Note: It is not advisable to keep your files in the Simcenter Flomaster
folder. Instead, you should keep them in the 'Documents and Settings'
folder. For example: C:\Documents and Settings\User name\MyXMLFiles
Arg2 This is an optional argument that you can use to define an output file to
catch any errors. Again, you should define the full path.
Note: If you do not create an errors file and an error is encountered,
then one will be automatically created.
Arg3 This is an optional argument that you can use to specify license.
Note:
• If no license is specified then:
• All commands except RunBatch and RunBatchSync prioritize the
Build license.
• RunBatch and RunBatchSync will select the most capable license.
• If a license is named then it will validate the name and check it out if
available.

Having created the Batch, the next stage is process it.

October 2020
Creating Batch Files
Procedure
1. Run the 'Command Interpreter', Cmd.exe to display the 'Command Interpreter' window.
2. Using the 'Change Directory' (cd) command, change the path shown to:
3. Enter the additional details as shown in below:
C:\Program Files (x86)\Simcenter\Flomaster>Flowmaster.CommandLine.exe
“RunBatchSync” “C:\Documents and Settings\User Name\MyBatchFiles\
MyBatchFile.fmbch”
4. Press the 'Return' key to execute the command. If any errors are detected, they are
reported in the errors file.
5. Open the network created by FMDNA function to confirm that the simulation has run,
and that no errors have occurred.
Related Topics

To create a batch file:
Procedure
1. Choose New/Edit Command Line File from the Tools menu.option.
The File Creation/Editing Options dialog box is displayed.
2. Select the Batch File option and then click OK to display the Batch Analysis dialog
box.
3. Attach the EDIF file by clicking the button next to String Array to display the String
Collection Editor dialog box.
4. Enter the path to the folder where the EDIF file is located.
5. Complete the Logon details:
Table 44-2. Creating a Batch File

Field Description
Batch File Details
Description
EDIF Files Details

October 2020
Table 44-2. Creating a Batch File (cont.)

Field Description
EDIFFiles You can use this field to enter associated strings:
1. Click the + sign to display a button.
2. Click the button to display the String Collection Editor
dialog box.
3. Enter the relevant details and then click OK.
Logon Details
DataSource This is the location of the SQL Database. It can be one of the
following:
• The SQL Server 2008 Express that runs on your desktop, or
• A full SQL Server (e.g. SQL Server 2008) that you access
via your network.
If you are using the SQL Server 2008 Express, then you need to
enter the name as shown in the example below:
If you are accessing the full SQL Server, then you need to
define the full path name to the location of the database.
DataBase This is the name of the database you are accessing.
UserName Your Simcenter Flomaster user name.
Password The password that has been assigned to you by your system
administrator.
RoleName If you are using the 'User Group Management' functions this is
the role that has been assigned to a particular user.
DatabaseType Shows the type of database. The default is SQL.
DatabaseUserName The name assigned to you by the system administrator.
DatabaseUserPassword The password assigned to you by the system administrator.
DatabasePortNo Only applicable if you are using an Oracle database. It refers to
the port number on which the database is hosted. The default is
as shown.
LogonProject This is the name of the project that you want to logon to.
6. Click OK to generate the XML file.
The windows Save As dialog box is displayed.
7. Navigate to the folder where the XML file will be stored. You are advised to store your
files in a sub-folder, in the Documents and Settings folder. For example:
C:\Documents and Settings\User Name\MyBatchFiles

October 2020
Using the 'CreateProject' Function
Related Topics

You can create new command line projects.
Procedure
1. Choose New/Edit Command Line File from the Tools menu.' option.
2. Select the Create Project option and then click OK to display the Create Project dialog
box:
Figure 44-2. The Create Project Dialog Box

October 2020
3. Then:
Table 44-3. Creating a New Project

Field Description
Logon Details
Data Source This is the location of the SQL Database. It can be:
• The SQL Server 2008 Express that runs on your desktop, or
• A full SQL Server (e.g. SQL Server 2008) that you access
via your network.
If you are using the SQL Server 2008 Express, must enter the
name as shown below:
Note: If you are accessing the full SQL Server, then you
need to define the full path name to the location of the
database.
DataBase This is the name of the database you are accessing.
Note: If you are accessing your own database, then you will
need to enter its name in this field.
LogonProject This is the name of the project that you want to logon to.
UserName This is the name you normally enter when you want to use
Password Unless you are an administrator, in which case you would have
assigned yourself a password, then this is the password that has
been assigned to you, by your system administrator.
RoleName If you are using the 'User Group Management' functions, then
this refers to the role that has been assigned to a particular user.
DatabaseUserName Unless you are an administrator, in which case you would have
assigned yourself a name, then this is the name that has been
assigned to you, by your system administrator.
DatabaseUserPassword Unless you are an administrator, in which case you would have
as shown.
New Project Details
Name This is the name of the project that you want to create.
Description You can use this field to enter a brief description of the project
you are creating.

October 2020
Executing the 'CreateProject' Function

The windows Save As Dialog Box is displayed.
5. Navigate to the folder where the XML file will be stored.
Note
You are advised to store your files in a sub-folder, in the Documents and Settings
folder. For example:
C:\Documents and Settings\User Name\MyXMLFiles
Related Topics

Once created, you can execute the CreateProject function.
Procedure
1. Run the Command Interpreter, Cmd.exe to display the Command Interpreter window.
2. Using the Change Directory (cd) command, change the path to:
3. Enter the additional details below (which includes the path to the location of the file):
C:\Program Files (x86)\Simcenter\FlomasterFlowmaster.CommandLine.exe
"CreateProject" "C:\Documents and Settings\User Name\MyXMLFiles\
MyNewProject.xml"
4. Press the Return key to execute the command. If any errors are detected, they are
5. Open Simcenter Flomaster to confirm that the project has been created.
Related Topics
Using Command Line Utilities to Create a New

Network
There are two steps involved in creating a new network using the command line utilities. First
you must create the XML file and then execute the function via the command line.

October 2020
Using Command Line Utilities to Create a New Network
Procedure
1. Choose New/Edit Command Line File from the Tools menu.
2. Select the Create Network option and then click OK to display the Create Network
dialog box:
3. Click Open.
The Create Network dialog box is displayed:
Figure 44-3. The Create network Dialog Box
4. Then:
Table 44-4. Creating a New Network

Field Description

October 2020
Table 44-4. Creating a New Network (cont.)

Logon Details
Data Source This is the location of the SQL Database. It can be one of the
following:
1. The SQL Server 2008 Express that runs on your desktop, or
2. A full SQL Server (e.g. SQL Server 2008) that you access
via your network.
If you are using the SQL Server 2008 Express enter the name as
shown below:
DataBase This is the name of the database you are accessing. In most
case, this will be the shipped version of the database which is
called Flomaster.
If you are accessing your own database, then you will need to
enter its name in this field.
LogonProject This is the name of the project that you want to logon to. In
most cases, this will be the 'top level' project.
If you want to create a network that is attached to a particular
project, then you will first have to perform the following
actions:
1. Go into Simcenter Flomaster, and assign yourself as user to
the project in question, and
2. Assign yourself a password.
If you are logging-on to a particular project, then this will be
the name that you have assigned yourself in order to access the
project in question.
RoleName If you are using the User Group Management functions, then
DatabaseUserName Unless you are an administrator, in which case you would have
assigned yourself a name, then this is the name that has been
assigned to you, by your system administrator.

October 2020
Table 44-4. Creating a New Network (cont.)

as shown.
New Network Details
Name This is the name of the project that you want to create.
Description You can use this field to enter a brief description of the project
you are creating.
NetworkProject This is the name of the project that will ‘own’ the network
files in a sub-folder, in the 'Documents and Settings' folder. For example:
7. Execute the CreateNetwork Function by:
a. Run the Command Interpreter, Cmd.exe to display the Command Interpreter
window.
b. Using the Change Directory (cd) command, change the path shown to:
C:\Program Files\Simcenter\Flomaster>
c. Enter the details below, which includes the path to the location of the file:
C:\Program Files\Simcenter\FlomasterFlowmaster.CommandLine.exe
"CreateNetwork" "C:\Documents and Settings\User Name\MyXMLFiles\
MyNewNetwork.xml"
d. Press the Return key to execute the command. If any errors are detected, they are
e. Open Simcenter Flomaster to confirm that the network has been created.
Related Topics
Deleting a Network using the Command Line Utilities

October 2020
Deleting a Network using the Command Line

Utilities
You can delete networks using the command line utilities.
Procedure
1. Choose New/Edit Command Line File from the Tools menu.
2. Select the Delete Network option and then click OK to display the Delete Network
dialog box:
Figure 44-4. The Delete Network Dialog Box

October 2020
3. Then:
Table 44-5. Deleting a New Network

Field Description
Delete Network Details
Network This is the name of the network that you want to delete
Project This is the name of the project that ‘owns’ the network that you
want to delete.
Logon Details
Data Source This is the location of the SQL Database. It can be one of the
following:
1. The SQL Server 2008 Express that runs on your desktop, or
2. A full SQL Server (e.g. SQL Server 2008) that you access
via your network.
If you are using the SQL Server 2008 Express enter the name as
shown below:
case, this will be the shipped version of the database which is
called Flomaster.
If you are accessing your own database, then you will need to
enter its name in this field.
If you want to create a network that is attached to a particular
project, then you will first have to perform the following
actions:
1. Go into Simcenter Flomaster, and assign yourself as user to
the project in question, and
RoleName If you are using the 'User Group Management' functions, then

October 2020
Executing the 'DeleteNetwork' Function
Table 44-5. Deleting a New Network (cont.)

DatabaseUserName Shows the type of database. The default is SQL
The windows 'Save As' Dialog Box is displayed.
files in a sub-folder, in the Documents and Settings folder.
For example:
C:\Documents and Settings\User name\MyXMLFiles
Related Topics
Executing the 'DeleteNetwork' Function

Once you have created a delete network function you can execute it.
Procedure
2. Using the Change Directory (cd) command, change the path shown to:
3. Enter the additional details below, which includes the path to the location of the file:
"CreateNetwork" "C:\Documents and Settings\User Name\MyXMLFiles\
MyNewNetwork.xml"
Unpacking a Network
You use the 'UnpackNetwork' function to unpack a network.
Procedure
1. SelectNew/Edit Command Line File from the Tools menu.

October 2020
Unpacking a Network

2. Select the Unpack Network option and then click OK to display the Unpack Network
dialog box:
Figure 44-5. The Unpacking Network Dialog Box
3. Then:
Table 44-6. Unpacking a New Network

Field Description
Logon Details

October 2020
Unpacking a Network
Table 44-6. Unpacking a New Network (cont.)

Data Source This is the location of the SQL Database. It can be one of
the following:
1. The SQL Server 2008 Express that runs on your
desktop, or
2. A full SQL Server (e.g. SQL Server 2008) that you
access via your network.
If you are using the SQL Server 2008 Express, then you
need to enter the name as shown in the example below:
case, this will be the shipped version of the database which
is called Flomaster.
If you are accessing your own database, then you will need
to enter its name in this field.
If you want to create a network that is attached to a
particular project, then you will first have to perform the
following actions:
1. Go into Simcenter Flomaster, and assign yourself as
user to the project in question, and
Password Unless you are an administrator, in which case you would
have assigned yourself a password, then this is the
password that has been assigned to you, by your system
administrator.
RoleName If you are using the 'User Group Management' functions,
then this refers to the role that has been assigned to a
particular user.
DatabaseUserName Shows the type of database. The default is SQL
DatabaseUserPassword Unless you are an administrator, in which case you would
administrator.

October 2020
Unpacking a Network
Table 44-6. Unpacking a New Network (cont.)

DatabaseUserPassword Unless you are an administrator, in which case you would
administrator
DatabasePortNo Only applicable if you are using an Oracle database. It
refers to the port number on which the database is hosted.
The default is as shown.
Unpack Network Details
PackFileName This is the full path and name of the pack file that you want
to unpack.
UnpackResults The settings are:
False: Only the network is unpacked.
True: Network and associated results are unpacked.
UseExistingData The settings are:
False: The network and associated performance data items
are unpacked, and the autoname convention is used by
adding a '+' sign to the relevant item name.
True: There are two cases to be considered; namely:
1. If the network and associated performance data are
NOT present in the database, then both are unpacked.
2. If the network AND the associated performance data are
allready present in the database, then both are
overwritten.
UsePackedHierarchy When set to True the hierarchy (the folder and subfolder
structure of the pack file contents) is retained.
ReplaceExistingCAMDLLs When set to True any CAM DLLs that already exist are
overwritten.
files in a sub-folder, in the 'Documents and Settings' folder. For example:
Related Topics
Executing the 'UnpackNetwork' Function

October 2020

Once you have created an unpack network function you can execute it.
Procedure
2. Using the Change Directory (cd) command, change the path shown to:
3. Enter the additional details below, which includes the path to the location of the file:
"UnpackNetwork" "C:\Documents and Settings\User Name\MyXMLFiles\
MyPackedNetwork.xml"
5. Open the folder to confirm that the network has been unpacked.
Related Topics
Unpacking a Network

October 2020

October 2020
Appendix A
Performance Data Functions
This appendix details the functions that are available when using performance data to create
new CAMs. All of the functions are members of the Flowmaster.Interfaces.IFormDataProvider
interface.
Each function is described with input and output variables shown, together with an example of
its use. In all of the functions, m_DP is declared as the Data Provider and M_BrP is declared as
the Branch Result Provider. For the 2D functions, the key name for the curve is “Curve”, while
the key name for the surface is “Surface”. All other variables are assumed to be declared
elsewhere in the CAM.
GetYfromX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
GetY_dydxFromX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
GetY_dYdXfromIntlExtrapolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 870
GetXfromY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
EvaluateIntegral. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
GetXLimits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
IsCurveSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
GetZfromXY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
GetZandGradfromXandY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
GetXorYfromSurfaceUsingBisection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
GetYLimits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
IsSurfaceSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880

October 2020
GetYfromX
GetYfromX
Returns the Y value from a curve or equation feature at a specified X value.
Syntax
double GetYfromX(short key, double dx, out FlowmasterInterfaces.ReadStatus
nStatus)
Parameters
• key
The feature’s key.
• dX
The value of X at the point at which the Y value is required.
• nStatus
The status of the completed request.
Return Values
The required Y value.
Examples
ReadStatus CurveIsRead; Double xVal = 1.0
Double yVal = m_DP.GetYfromX((short)Key.Curve,xVal,out CurveIsRead);
Note
If y is requested for a value of x outside the range specified, then the function will return the
minimum\maximum value of x as appropriate. The value of nStatus can be tested to check if
clipping has occurred. The script below checks to see if the truncation has occurred and outputs
a warning if it has.
if (CurveIsRead == ReadStatus.Clipped)
{
int m_nUserCompNo = m_Services.GetUserComponentNo(m_nComponentNumber);
m_ErrHandler.ReportWarningMsg("Curve of k vs Re for Component"
+ m_nUserCompNo.ToString() + "is outside data range, value is clipped");
}
The above code first checks if the curve has been clipped, and if it has it creates a new integer
called m_nUserCompNo whose value is set to the component number seen in the schematic.
This is then output as a warning with a description of the error

October 2020
GetY_dydxFromX
GetY_dydxFromX
Obtains a Y value and a gradient value from a curve or equation feature for a specified X value.
Syntax
void GetY_dYdXfromX(short key, double dX, out double dY, out double dYdX,
out Flowmaster.Interfaces.ReadStatus nStatus)
Parameters
• key
• dX
• dY
• dYdX
The required gradient value.
• nStatus
Examples
double x,y,dy; ReadStatus CurveIsRead; x = 1.0;
m_DP.GetY_dYdXfromX((short)Key. Curve,x,out y,out dy,out CurveIsRead);
Note
If the value of x being requested is outside the range of the supplied data, then the value of y
will be evaluated at the specified value of x using extrapolation. Use this function instead of
GetYFromX, if you want to use extrapolation instead of clipping for values outside the
specified data range. The extrapolation is based on the gradient at the end of the curve. The
value of nStatus can be tested to check if extrapolation has occurred. The script below tests to
see if the extrapolation has occurred and outputs a warning if it has.
if (CurveIsRead == ReadStatus.Extrapolated)
{
m_ErrHandler.ReportWarningMsg("Curve has been extrapolated")
}

October 2020
GetY_dYdXfromIntlExtrapolation
GetY_dYdXfromIntlExtrapolation
This function is the same as GetY_dydxFromX, obtaining a Y value and a gradient value from a
curve or equation feature at a specified X value. An enhanced routine designed for use with fans
and blower components, it is used in the extrapolation of the curve where the value of x
specified is outside the range of data entered.
Syntax
void GetY_dYdXfromIntlExtrapolation(short key, double dX, out double dY,
out double dYdX, out Flowmaster.Interfaces.ReadStatus nStatus)
Parameters
• key
• dX
• dY
• dYdX
• nStatus
Examples
double x,y,dy; ReadStatus CurveIsRead; x = 1.0;
m_DP.GetY_dYdXfromXIntlExtrapolation((short)Key.Curve,x,out y,out dy,out
CurveIsRead);
Note
If the value of x being requested is outside the range of the supplied data, then the value of y
will be evaluated at the value of the specified x using extrapolation. Use this function
instead of GetYFromX if you want to use extrapolation instead of clipping for values outside
the specified data range. Extrapolation is performed using a parabola rather than linear
interpolation using GetY_dYdXfromIntlExtrapolation. The value of nStatus can be tested to
check if extrapolation has occurred. The script below checks to see if extrapolation has occurred
and to output a warning if it has.
if (CurveIsRead == ReadStatus.Extrapolated)
{
m_ErrHandler.ReportWarningMsg("Curve has been extrapolated")
}

October 2020
GetXfromY
GetXfromY
Returns the X value from a curve or equation feature at a specified Y value.
Syntax
Parameters
• key
• dY
The value of Y at the point at which the X value is required.
• nStatus
Return Values
Examples
ReadStatus CurveIsRead; Double x, y;
y=5;
x = m_DP.GetXfromY((short)Key.Curve, xVal,out CurveIsRead);
Note
If x is requested for a value of y that is outside the range specified, then the function will
return the minimum or maximum value of y as appropriate. The value of nStatus can be
tested to check if clipping has occurred. The script below checks to see if truncation has
occurred and to output a warning if it has.
if (CurveIsRead == ReadStatus.Clipped)
{
m_ErrHandler.ReportWarningMsg("Curve of k vs Re for Component"
+ m_nUserCompNo.ToString() + "is outside data range, value is clipped");
}
The above code first checks if the curve has been clipped, if it has it creates a new integer called
m_nUserCompNo whose value is set to the component number the user sees in the schematic.
This is then output as a warning with a description of the error.

October 2020
EvaluateIntegral
EvaluateIntegral
Evaluates the area under the specified curve between the specified 'X-axis' units, using the
trapezoidal method.
Syntax
double EvaluateIntegral(short nKey, double dXMin, double dXMax, out
Flowmaster.Interfaces.ErrorStatus eStatus)
Parameters
• nKey
• dXMin
The minimum X limit.
• dXMax
The maximum X limit.
• eStatus
The error status.
Return Values
The evaluated integral between the specified limits.
Examples
Double xMin, xMax;
ErrorStatus CurveIsInt;
y = m_DP.EvaluateIntegral((short)Key.Curve, xMin, xMax, out CurveIsInt);
Note
The curve is integrated between the limits xMin and xMax. If the limits are outside the
range of data, then the result should be treated with caution as interpolation is used in
calculating the points. To check if this is the case, the ErrorStatus can be interrogated. If xMin is
less than the minimum data value, or xMax is greater than the maximum data value then an
error status of XMNBL will be reported. Similarly, if both limits are outside the data range then
an error status of XMXBL will be reported. If neither condition is met the status will be reported
as OK. The code below can be used to test for these conditions and to output a warning.
if (CurveIsInt == ErrorStatus.XMNBL)
{
m_ErrHandler.ReportWarningMsg("Curve Integrated under minimum x value");
}
else if (CurveIsInt == ErrorStatus.XMXBL)
{
m_ErrHandler.ReportWarningMsg("Curve Integrated under minimum x value");
}

October 2020
GetXLimits
GetXLimits
Returns the X axis min and max limits from a curve or equation feature.
Syntax
void GetXLimit(short key, out double dMinX, out double, dMaxX, out
FlowmasterInterfaces.ReadStatus nStatus)
Parameters
• key
• dMinX
The curve or equation's minimum X value.
• dMaxX
The curve or equation’s maximum X value.
• nStatus
Return Values
The minimum and maximum values of the input data on the X axis of the curve or equation.
Examples
int xMin, xMax;
m_DP.GetXLimits((short)Key.Curve, out xMin, out xMax, out CurveIsRead);

October 2020
IsCurveSet
IsCurveSet
Checks to see if the specified curve/2D equation is set on the data form.
Syntax
bool IsCurveSet(short key)
Parameters
• Key
The key for the specified curve/2D equation.
Return Values
Returns TRUE if the curve/2D equation is set, else FALSE.
Examples
bool CurveSet;
CurveSet = m_DP.IsCurveSet((short)key.Curve);
if (CurveSet == false)
{
m_ErrHandler.ReportErrorMsg("Curve not set");
}

October 2020
GetZfromXY
GetZfromXY
Returns the Z value from a surface feature for the specified X and Y values.
Syntax
double GetZfromXY(short key, double dx, double dY, out
Parameters
• key
• dX
The X value at the point at which the result is required.
• dY
The Y value at the point at which the result is required.
• nStatus
Return Values
The required Z value.
Examples
double xVal, yVal, zVal; ReadStatus SurfaceIsRead;
zVal=m_DP.GetZfromXY((short)Key.Surface, xVal, yVal, out SurfaceIsRead);
Note
If z is requested for a value of x or y that is outside the specified range, the function will
return the z at the minimum or maximum value of x or y as appropriate. The value of
nStatus can be tested to check if clipping has occurred. The script below can be used to check if
the truncation has occurred and to output a warning if it has.
if (SurfaceIsRead==ReadStatus.Clipped)
{
m_ErrHandler.ReportWarningMsg("Surface for Component" +
m_nUserCompNo.ToString() + "is outside data range, value is clipped");
}

October 2020
GetZandGradfromXandY
GetZandGradfromXandY
Returns the Z value and gradient of a surface feature for the specified X and Y values.
Syntax
double GetZandGradfromXandY(short key, double dx, double dY, out double
dZGrad, out FlowmasterInterfaces.ReadStatus nStatus)
Parameters
• Key
• dX
The X value at the point at which the result is required.
• dY
The Y value at the point at which the result is required.
• dZGrad
• nStatus
Return Values
Examples
double xVal, yVal, zVal; DzDxDy; ReadStatus SurfaceIsRead;
zVal=m_DP.GetZandGradfromXandY((short)Key.Surface, xVal, yVal, DzDxDy,
out SurfaceIsRead);
Note
If z is requested for a value of x or y outside the range specified, the function will return the
z at the minimum or maximum value of x or y as appropriate. The value of nStatus can be
tested to check if clipping has occurred. The script below can be used to check if truncation has
{
m_nUserCompNo.ToString() + " is outside data range, value is clipped");
}

October 2020
GetXorYfromSurfaceUsingBisection
This subroutine is used to access surface values via a bisection routine as the calling method
provides access to either the x or y value and a z value, and requires either x or y. Mode
indicates which of x or y is required. VALMIN and VALMAX provide estimates to act as the
upper and lower bounds on the bisection.
Syntax
double GetXorYfromSurfaceUsingBisection(short key, double Known, double
ZVal, double ValMin, double ValMax, intMode, intCurrentIteration, out
Parameters
• key
• Known
The given value of X or Y.
• ZVal
The given value of Z.
• ValMin
The lower bound for the unknown X or Y.
• ValMax
The upper bound for the unknown X or Y.
• Mode
Depends on whether X or Y is specified (1 = x specified, 2 = y specified).
• CurrentIteration
The Current Iteration number.
• nStatus
Return Values
Examples
double xVal, yVal, zVal; zMin, zMax;
int CurrIteration;
//specifying x value to calculate y int Mode = 1;
ReadStatus SurfaceIsRead;
yVal=m_DP.GetXorYfromSurfaceUsingBisection((short)Key.Surface, xVal,
yVal, zMin, zMax, Mode, CurrIteration out SurfaceIsRead);

October 2020
Note
If z is requested for a value of x or y outside the range specified, the function will return the
z at the minimum or maximum value of x or y as appropriate. The value of nStatus can be
used to check if clipping has occurred. The script below can be used to check if truncation has
{
m_nUserCompNo.ToString() + "is outside data range, value is clipped");
}

October 2020
GetYLimits
GetYLimits
Returns the Y axis min and max limits from a surface or 3D equation feature.
Syntax
void GetYLimit(short key, out double dMinY, out double, dMaxY, out
Parameters
• Key
• dMinY
The surface’s or 3D Equation’s minimum Y value.
• dMaxY
The surface’s or 3D Equation’s maximum Y value.
• nStatus
Return Values
The minimum and maximum values of the input data on the X axis of the curve or equation.
Examples
int yMin, yMax;
m_DP.GetYLimits((short)Key.Surface, out yMin, out yMax, out
SurfaceIsRead);

October 2020
IsSurfaceSet
IsSurfaceSet
Checks to see if the specified surface/3D equation is set on the data form.
Syntax
bool IsSurfaceSet(short key)
Parameters
• Key
The key for the specified surface or 3D equation.
Return Values
Returns TRUE if the surface or 3D equation is set, else it returns FALSE.
Examples
bool SurfSet;
SurfSet = m_DP.IsSurfaceSet((short)key.Surface);
if (SurfSet == false)
{
m_ErrHandler.ReportErrorMsg("Surface not set");
}

October 2020
Third-Party Information
Details on open source and third-party software that may be included with this product are available in the
<your_software_installation_location>/legal directory.

Simcenter Flomaster User Guide: Software Version 2020.2 October 2020

Uploaded by

Copyright:

Available Formats

You might also like

Simcenter Flomaster User Guide: Software Version 2020.2 October 2020

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Simcenter Flomaster User Guide: Software Version 2020.2 October 2020

Uploaded by

Copyright:

Available Formats

Simcenter Flomaster™ User Guide

Software Version 2020.2

Support Center: support.sw.siemens.com

Simcenter Flomaster™ User Guide, v2020.2 3

Deleting Sample Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

4 Simcenter Flomaster™ User Guide, v2020.2

Replacing Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Simcenter Flomaster™ User Guide, v2020.2 5

Geometric Heat Exchanger Wizard - Connectivity Examples . . . . . . . . . . . . . . . . . . . . . . 195

6 Simcenter Flomaster™ User Guide, v2020.2

Creating a New Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Simcenter Flomaster™ User Guide, v2020.2 7

Creating a Loss Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

8 Simcenter Flomaster™ User Guide, v2020.2

Generating an Input Data Browser Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Simcenter Flomaster™ User Guide, v2020.2 9

10 Simcenter Flomaster™ User Guide, v2020.2

Using the Cavity Configuration Wizard - Dividing the Cavity . . . . . . . . . . . . . . . . . . . . . 502

Simcenter Flomaster™ User Guide, v2020.2 11

Running a Component Interaction Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595

12 Simcenter Flomaster™ User Guide, v2020.2

Adding Signal Links for a Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657

Simcenter Flomaster™ User Guide, v2020.2 13

Importing a New Pipe Schedule Standard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731

14 Simcenter Flomaster™ User Guide, v2020.2

Maintaining Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788

Simcenter Flomaster™ User Guide, v2020.2 15

16 Simcenter Flomaster™ User Guide, v2020.2

Figure 3-1. The Project Properties Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Simcenter Flomaster™ User Guide, v2020.2 17

Figure 6-30. Geometric Heat Exchange Wizard - Generic Example. . . . . . . . . . . . . . . . . . . 201

18 Simcenter Flomaster™ User Guide, v2020.2

Simcenter Flomaster™ User Guide, v2020.2 19

Figure 15-8. The XML Source Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492

20 Simcenter Flomaster™ User Guide, v2020.2

Figure 27-2. Modeling 1D Heat Transfer - Example Network . . . . . . . . . . . . . . . . . . . . . . . 623

Simcenter Flomaster™ User Guide, v2020.2 21

Figure 30-32. FMDNA File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676

22 Simcenter Flomaster™ User Guide, v2020.2

Figure 40-8. Hybrid Results - The Results Set/Audit Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . 814

Simcenter Flomaster™ User Guide, v2020.2 23

24 Simcenter Flomaster™ User Guide, v2020.2

Table 1-1. The Simcenter Flomaster Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Simcenter Flomaster™ User Guide, v2020.2 25

Table 7-10. Generating the Code Stub—Interface Settings . . . . . . . . . . . . . . . . . . . . . . . . . 253

26 Simcenter Flomaster™ User Guide, v2020.2

Table 15-3. Example (b) - Constant Blocks (Repeating) . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

Simcenter Flomaster™ User Guide, v2020.2 27

28 Simcenter Flomaster™ User Guide, v2020.2

Starting Simcenter Flomaster

3. Click the button.

Simcenter Flomaster™ User Guide, v2020.2 29

30 Simcenter Flomaster™ User Guide, v2020.2

Application Window Basics

Simcenter Flomaster™ User Guide, v2020.2 31

Table 1-1. The Simcenter Flomaster Panes

32 Simcenter Flomaster™ User Guide, v2020.2

Table 1-2. Input Field Cell Colors (cont.)