Disclaimer
Information of a technical nature, and particulars of the product and its use, is given by AVEVA Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law. Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or entity for any actions, claims, loss or damage arising from the use or possession of any information, particulars, or errors in this publication, or any incorrect use of the product, whatsoever.
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every part of it (including source code, object code, any data contained in it, the manual and any other documentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries.
All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without the prior written permission of AVEVA Solutions Ltd. Where such permission is granted, it expressly requires that this Disclaimer and Copyright notice is prominently displayed at the beginning of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material or electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also not reverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the product described in this publication may be incorporated into any third-party software, product, machine, or system without the prior written permission of AVEVA Solutions Ltd, save as permitted by law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal prosecution.
The AVEVA products described in this guide are to be installed and operated strictly in accordance with the terms and conditions of the respective license agreements, and in accordance with the relevant User Documentation. Unauthorised or unlicensed use of the product is strictly prohibited.
First published September 2007
© AVEVA Solutions Ltd, and its subsidiaries
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised use of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its subsidiaries, registered in the UK, Europe and other countries (worldwide).
Equipment User Guide
Contents
Page
12.0 i
Equipment
Read this First . . . 1:1
Scope of this Guide . . . 1:1
Intended Audience . . . 1:1
Assumptions. . . 1:1
How the Guide is Organised . . . 1:1
Equipment Overview. . . 2:1
Starting the Equipment Application . . . 2:1
Equipment Toolbars . . . 2:2
SITEs and ZONEs . . . 2:2
Creating a SITE and a ZONE. . . 2:3
Using Names . . . 2:3
Listing Elements . . . 2:4
Importing Equipment Data . . . 3:1
Rules for Content of the Import CSV File . . . 3:4
Creating Equipment . . . 4:1
Creating Sub-Equipment . . . 4:1
Creating Primitives . . . 4:2
Using Levels. . . 4:4
Datum
. . . 4:5
Position
. . . 4:5
Rotate
. . . 4:5
Align with P-Point . . . 4:6
Creating an Extrusion. . . 4:6
Creating a Revolution. . . 4:9
Checking the P-point Position of a Primitive . . . 4:15
Creating Nozzles . . . 4:16
Creating Electrical Components. . . 4:16
Create Equipment Form . . . 4:18
Creating Equipment Points . . . 4:21
Modifying Equipment . . . 5:1
Modifying Equipment Specifications . . . 5:1
Plotfile Form . . . 5:2
Modify Properties Form . . . 5:3
Modifying Nozzle Specifications . . . 5:3
Modifying Electrical Component Selection . . . 5:4
Modifying Primitives . . . 5:4
Modifying Stretch / Trim a Primitives . . . 5:6
Sliding a Primitive. . . 5:7
Modifying a Design Item’s System Attribute . . . 5:7
Deleting Equipment. . . 6:1
Deleting an Equipment . . . 6:1
Deleting an Equipment Primitive . . . 6:2
Parameterised Design Template Equipment . . . 7:1
Equipment Assembly Modelling Options . . . 7:3
Equipment Associations . . . 8:1
Equipment Reporting . . . 9:1
Selecting the Attributes to Appear in the Report . . . 9:2
12.0 iii
Saving the Report . . . 9:3
Copying Equipment . . . 10:1
Working with Equipment . . . 11:1
Axis System . . . 11:1
Positioning Control . . . 11:1
Positioning Using P-points . . . 11:7
Positioning Equipment Point . . . 11:8
At Explicit . . . 11:8
At General . . . 11:9
Through
. . . 11:10
Clearance . . . 11:13
Towards
. . . 11:15
Orientation . . . 11:17
Orientate Axis. . . 11:17
Orientate Rotate . . . 11:18
Orientate Primitive Point. . . 11:19
Connect
. . . 11:20
ID Point
. . . 11:20
Explicit
. . . 11:21
Model Editor . . . 11:21
Set Increment Values . . . 11:22
Locking / Unlocking Objects . . . 11:24
Equipment Model Editor Pop-ups . . . 11:25
Linear Handle Pop-ups. . . 11:26
Rotation Handle Pop-up . . . 11:27
Moving Equipment Linear . . . 11:28
Enter Value. . . 11:28
Align with Feature. . . 11:29
Snap to Point . . . 11:30
Move Handle . . . 11:30
Moving Equipment Planar (Enter Values) . . . 11:32
Moving Equipment Angular . . . 11:34
Enter Value. . . 11:34
Orient to Point . . . 11:35
Align with Direction. . . 11:36
Align With . . . 11:37
Rotate Handle . . . 11:39
Exercises . . . 12:1
Worked Example (Create SITE ZONE and Equipment). . . 12:1
Negative Primitive . . . 12:6
Creating Standard Equipment . . . 12:9
Create a Heat Exchanger. . . 12:13
Creating a Primitives . . . 12:15
Modifying Equipment. . . 12:17
Creating a Nozzle . . . 12:18
Create a Pressure Vessel . . . 12:19
Modifying a Nozzle Specification . . . 12:20
Reports
. . . 12:21
12.0 1:1
1
Read this First
1.1
Scope of this Guide
This guide introduces the Equipment Application within the DESIGN Module. It explains the menus and forms available to define equipment within the design environment.
1.1.1
Intended Audience
This guide has been written for engineers familiar with Equipment elements that may or may not have prior knowledge of PDMS.
1.1.2
Assumptions
For you to use this guide, the sample PDMS project, Project SAM, must be correctly installed on your system, and you must have read/write access to the project databases. It is assumed that you know:
• where to find PDMS on your computer system
• you know how to use the Windows operating system installed on your site. Contact your systems administrator if you need help in either of these areas.
1.2
How the Guide is Organised
This guide is divided into chapters, as follows:
Equipment Overview Provides an overview of the Equipment Module.
Importing Equipment Data Describes the process for importing data from external files.
Creating Equipment Describes how to create new equipment.
Modifying Equipment Describes how to amend equipment.
Deleting Equipment Describes how to delete equipment.
Parameterised Design Template Equipment
Describes an example of a parameterised template.
Equipment Associations Describes how to create an Association World and an Association Group.
Equipment Reporting Describes the process for generating and outputting reports.
Copying Equipment Describes how to generate a new element based upon the parameters of an existing element.
Working with Equipment Describes how to work with Equipment.
12.0 2:1
2
Equipment Overview
This User Guide details how to work with equipment within the DESIGN Module. In practice you will usually create and manipulate equipment using the Design Template application, within which you can create equipment that is available for all projects by associating it with a catalogue. This is particularly useful when an item is a bought-in item that may be purchased from a standard set of items from a 3rd party.
There are occasions when an item will be specific to a project or be manufactured as a one-off bespoke item for a project. It that case it may not be appropriate to define the item within a catalogue or have it available for other projects.
Equipment items consist of a collection of primitives, arranged in such a way that they physically model the real life object to some degree. When you build equipment, you need to decide how you want to model the object, just as you would if you were building a plastic model. The only difference in terms is that you model the object at full size rather than working to a scale.
2.1
Starting the Equipment Application
To start the equipment application we must first choose Design > Equipment to set the
2.2
Equipment Toolbars
Note: The arrow can be used to navigate to different levels of the equipment i.e.Equipment,
Sub Equipment or Element.
2.3
SITEs and ZONEs
Before you can create any Equipment, Pipes, Ventilation, etc. we need to create a SITE and a ZONE. These two elements are a way of grouping items in specific areas to allow greater control of the model.
Create Standard Equipment
Modify Properties
Modify Position
Modify Orientation
12.0 2:3
2.3.1
Creating a SITE and a ZONE
1. Using the Design Explorer window navigate to the WORL level
2. Now select Create > Site from the main pull down menus, the Create Site form appears:
3. Key in an appropriate name for the SITE. 4. Select a Purpose from the drop down menu. 5. Click OK. The SITE is created.
6. Using the Design Explorer window navigate to the newly created SITE level.
7. Select Create > Zonefrom the main pull down menus, the Create Zone form appears. 8. Key in an appropriate name for the ZONE, select a Purpose from the drop down menu. 9. Click OK. The ZONE is created
Note: Remember to create any element, you need to be positioned at the correct level in
the hierarchy, so before you can create a zone, you must have a site.
2.4
Using Names
Any element in the database may be named. Names enable you to identify elements and to produce meaningful reports from the database. Which elements you attach names to is a matter of choice, but in general you would be expected to name all major design items such as Equipment, Nozzles, Pipes and Valves.
Conventionally, for equipment, you would probably name the main equipment and all of its nozzles. Nozzles usually carry the equipment name plus a suffix to identify the specific nozzle. For example nozzle 1 of an equipment called /YY9001 would probably be called / YY9001-N1, /YY9001/N1 or simply /YY9001/1. Whatever names you apply, the name convention is usually defined in the project specification used for the project you are working on. It is probable that the project will have Autonaming rules set up for items such as nozzles so that the project conventions are followed in every detail.
Attaching names to elements may be done in a number of ways. If you are using the applications menus, most creation forms offer you an opportunity to name the element you are creating. If you forget to name an element, or want to change a name, then you can select the Modify > Name menu to change or set a new name, the following dialogue box: appears.
Key in the new required name, select the option to Re-name all, this will rename the equipment, nozzles and sub equipment identifiers to the same name as the equipment, then choose Apply.
All of the application forms allow you to input a name without the preceding slash (/) character. This is because the system adds this automatically during the command processing
Note: Names cannot contain spaces and are case sensitive. For example, /YY9001A is a
different name from /YY9001a or /yy9001A. Elements in a database are unique, i.e. they cannot have the same name or reference number.
2.5
Listing Elements
Lists are a temporary collection of elements on which operations can be performed that affect all the members of the list. Lists only last for the duration of Design session unless Forms & Display are saved.
The current list is displayed on a pull-down on the Default toolbar:
If there is no current list defined the pull-down will display No list. The pull-down also lets you select the current list if more than one list has been defined in the current session. Selecting Utilities > Lists from the main menu or clicking the Create/Modify Lists icon from the Default toolbar displays the Lists/Collections form.
12.0 2:5
The first step is to create a list by selecting Add > List from the form menu bar. A Create List form is displayed that allows you to give a Description to the list. The Description of the list will appear in the List pull-down on the form.
Elements may be added to the list by using the Add menu on the form.
The Add menu allows you to select members to add to the list. The options are
One or more element types, for example SCTN, PANE, may be entered in the Selection text box to filter the elements you wish to add to the list.
The selection may be further refined by adding a valid PML expression to the with Rule text box.
Examples of with Rule might be.
• SPREF EQ /DIN-SPEC/HE300A will add all HE300A sections in the selection source to the list.
• GTYP NE ‘ANG’ will add all SCTN elements whose Gtype is not equal to ANG in the selection source to the list.
CE Adds the current element
CE Members Adds the elements whose owner is the current element.
Identified Adds elements by identifying them with the cursor. Clicking the
Esc key on the keyboard ends the selection
The source of the selection is made by clicking one of the following radio buttons:
The selection may also be made by specifying a volume, either explicitly or with a 3D
cursor, and selecting whether part of or the entire element is within the volume by checking
the appropriate check box.
Whatever method is chosen to select the items to add to the list, the selected items will appear in the main window of the Lists / Collections form.
The format of the displayed list is controlled by the Format pull-down. The list may be displayed as element Name only, Description only or Name + Desc.
The elements in the list may be highlighted in the graphical view by checking the Highlight check box at the top of the form.
Commands may be directly applied to the list by entering valid syntax in the text box at the bottom of the form and clicking the Action button. It is recommended that you use this option only if you have a good understanding of syntax, otherwise use the list in conjunction with the appware.
For Element Enter an element, e.g. STRU or FRMW, name in the text box or navigate to an element in the Members List and type CE in the text box. The option box on the right allows you to select the current DB or All DB’s.
12.0 2:7
The contents of the list may be manipulated by removing elements from it. Selecting
Removefrom the Lists/Collections form menu bar gives you the same options as the Add menu described previously, with the following additions:
Choosing the Selection option from the menu displays the Remove from List form that operates in the same way as the Add to List form described previously.
List may be used where element selection is available on the appware forms, usually via an options box. For example, the Position By form, allows you to select a List as an option to apply the repositioning to.
The entered distances would be applied to all members of the current list, which is selected from the Lists pull-down box on the main toolbar.
from List Removes the highlighted element from the list
12.0 3:1
3
Importing Equipment Data
This function imports equipment tags, descriptions and other attributes from a CSV format or XLS format file.
It is anticipated that this function will be used near the beginning of a project to pre-populate a DESIGN database with a list of Equipment data from other Engineering data systems. It is not intended for the transfer of data from one Project to another. The geometry of the imported equipment will not be defined by this method. It will be necessary to complete the definition of the Equipment by using the Design Equipment GUI.
The import is a two-stage process that initially analyses the import file and reports errors and identifies if the entry is new or appears to exist already in the database. The second stage is to import those entries that you want to, based on the results of the analysis. The content of the import file used as the input for this function must follow certain rules as described below; otherwise the data import will be rejected by the system.
Note: The LEXICON Database must be correctly configured, and the supplied values must
be valid for the User Defined Attribute (UDA) being set.
The function is available when you select the Equipment Application, from within the DESIGN Module, and select Utilities>Import Equipment…
From the Import Data form, navigate to and highlight the required import file. If the import file is an XLS format file you need to select the XLS files (*.xls) option from the Files of type: pulldown list.
Press the Open button to display the content of the selected spreadsheet in the Spread
Sheet Import form.
At this stage no data has been loaded into the database. The form lets you preview the data being loaded from the import file. When the file is loaded, some preliminary analysis of the data is carried out, and the icons, displayed to the left of the table, indicate the result of that analysis.
This Icon indicates that an Equipment /IN-D1201 does not exist in the database. If this form is actioned, then an Equipment called /IN-D1201 will be created.
12.0 3:3
This Icon indicates that the system has identified a problem with this row of data. No action will be taken on rows with this Icon when the Load All Data or Load New Data button is actioned. Selecting this row in the table will display a message in the Messages area of the form to indicate why this row cannot be processed as shown in the picture above.
Pressing the Load All Data button will process all of the rows that create a new element or modify an existing element. Pressing the Load New Data button will only process the rows that create new elements.
New data is created at the current location in the database if an owning element field is not included in the imported file. Note that the owning element is considered to be the current element when the file was loaded and the rows of data analysed, not the current element when a Load button is pressed. If an owning element field is provided in the import file, the system will attempt to create elements under the specified owner.
The example form below shows the result of pressing the Load All Data button.
Now the Icons on the form indicate the result of the load operation.
This Icon indicates that the creation or modification operation was successful. An element has been created or modified in the database.
This Icon indicates that the operation has not completed successfully because of an error found while the system was trying to create or modify an element. If an attribute value is incorrect as shown in the example above, then the element has been created, but not all of its attribute data has been loaded. You can choose to use the undo function to remove all of the changes made by the load operation and revert the database back to its state before the load, or to deal with the erroneous elements individually.
Another import file can be loaded by using the File Open Icon, the Browse button or by typing a name directly into the filename field on the form.
The Reload Data button reloads the file shown in the filename field. This may be necessary if the current element was incorrect or an owner element was missing when the file was first loaded.
It is possible to load element types other than Equipment using this function. The example above shows User Defined Element Types (UDETS), refer to the Lexicon Reference
Manual, of equipment being created. If the imported file is carefully constructed it would be
possible to import other element types provided that fields in the file contain all of the required data. For example, a nozzle list could be loaded provided that the owning equipment name is provided in an Owner field for each nozzle element, and the Type field identifies the element as a nozzle.
3.1
Rules for Content of the Import CSV File
An import file must have the following characteristics. 1. The file must be a valid CSV format or XLS format file.
2. The first row of the file contains a list of headings. Each heading represents a column in the file containing an attribute of the elements being loaded.
3. There must be a NAME column; otherwise the file will not be loaded. The NAME column may contain the name of a new element, or the name of an existing element. If an existing element name is used, then this row is an update row for that element. The name used must obey the normal rules for element naming in Marine.
4. Another required column is the TYPE column. This column contains the database element type of the element being loaded, e.g. EQUI. If this column is absent, the file will not be loaded. If the Project has been configured with User Defined Element Types, then this column could contain a valid UDET name (e.g. :PUMP). If the named element already exists – but its element type does not match the TYPE in the file, then this row will be ignored and an error will be raised.
5. A special column that may be included is the OWNER column. If this column is present, it must contain the name of an existing element that will own each imported item when it is created. This owner name will be ignored if the imported item already exists – it is
12.0 3:5
7. Columns cannot be added for array type attributes unless those attributes can be set using a list of values in a single field in the file. For example, the string “10 20 30” in a DESP field would set design parameter 1 to 10, 2 to 20 and 3 to 30.
8. Every row following the heading row must contain the correct number of fields (columns) as defined by the heading row.
9. Every row must contain valid values, or no values, for each field.
10. If a new element is being created, an attribute will be set to its default value if a field in the file is empty. Two adjacent separators denote an empty field. The NAME and TYPE fields cannot be empty.
11. If an existing element is being modified, an attribute value will remain unchanged if a field in the file is empty.
12. It is not possible to unset an attribute value from a file, other than by providing the default value. For example “X0Y0Z0” for a position.
13. Each field in the file must be a text field. Care must be taken with fields containing values that are considered by Microsoft Excel to be a formula. For example a database reference number in the form “=123/456” would be considered to be a formula because of the “=” character. This can be overcome by preceding the “=” with a single quote character that forces the field to be treated as a text string. If the file will not load successfully into Microsoft Excel, it will not load successfully using this import function. Any import of new or modified element data will be subject to the data access control configuration implemented for the current user and Project.
This function will not attempt to claim data automatically in an Explicit Claim database. If the data is imported into an Implicit Claim database, then the appropriate elements will be claimed, if not already claimed by another user.
12.0 4:1
4
Creating Equipment
To create Equipment elements you can either use the Equipment applications or commands at the command line. Creating elements using the equipment applications can be done in two main ways.
Creating Equipment and Creating Standard Equipment, for Equipment itself, you can select the Create > Equipment menu to create an empty Equipment element, where you add different primitives to build up the graphical representation for the Equipment item. The Standard Equipment can be accessed by selecting the Create > Standard option on the menu bar, this takes you through a series of step allowing you to build up a parameterised equipment based on a specification of standard equipment types.
Using the Design Explorer navigate to the ZONE which will hold the equipment.
Select Create > Equipmentfrom the main pull down menus, the Equipment Creation form appears.
Key in the Name /YY1001, and then click OK. This procedure creates an equipment element with no member primitives.
Position the equipment origin by selecting the list buttons and entering coordinate values in the adjacent text boxes. (You can always create the equipment at the SITE origin and move it later.)
4.1
Creating Sub-Equipment
This function lets you define an equipment to be associated underneath existing equipment. Select the top level equipment as the current element to start.
The function is available when you select the Equipment Application, from within the DESIGN Module, and select Create > Equipment to open the Create
The upper level equipment is displayed in the Wrt field. Set the Name and Position of the element.
4.2
Creating Primitives
Primitives like Boxes should be built such that their lengths are aligned with the default axis system and not built in such a way that they need to be rotated from the default axis system. Obviously, some primitives will need to be rotated, but if you try to keep these to a minimum then any subsequent changes to the equipment will be easier.
The function is available when you select the Equipment Application, from within the DESIGN Module, and select Create > Primitives.
12.0 4:3
Select the primitive you want to create to change the display to show the available definition fields. Enter all relevant data for that specific type of primitive.
In order to build an equipment item, you first need to decide what types of primitives to use. As an example, the simple storage vessel shown below could be constructed from a cylinder for the main body, two dishes for the ends, two boxes for the support legs and a nozzle for the piping connection.
All of these ‘building blocks’ are selected from the list of available primitives.
4.2.1
Using Levels
The Used for drop down is used to select pre-defined level settings i.e for reserved space etc. The Levels defines the range of detailing levels at which the primitive is visible. For example, if you build a Volume, you can display the primitives in layers 1 - 3, the base in layers 5 - 7 and the nozzles in layer 8 - 10. The levels visible in design determine the picture you see. The current visible, levels are given by the Settings>Graphics>Representation menu.
12.0 4:5
4.2.2
Datum
The Datum area allows the Datum point to move i.e. a cylinder has an origin and two Ppoints, this will allow the datum to be sited at any of these points for ease of repositioning etc.
4.2.3
Position
The Position area allows each primitive to be positioned with respect to (wrt) another element.
Note: It is often easier to create Volumes at 0, 0, 0 and then reposition then later.
4.2.4
Rotate
The cylinder requires rotating around its x axis by 90 degrees, this will form the main body of the tank. Click on the Next button.
4.2.5
Align with P-Point
The Align with P-Point allows you to align the current element with a P-Point on another element to align the current element through.
4.2.6
Creating an Extrusion
Lets you create a set of extrusion vertices in various ways, depending on the requirements of your design and your personal preferences. It also lets you set the other attributes necessary to relate these vertices to a 3D extrusion representation.
The shape of an extrusion (EXTR) is defined by a loop (LOOP). The 2D geometry of the loop is defined by linking a set of vertices (VERTs), each with a position in the loop’s XY coordinate system. The Height (HEIG) attribute of the LOOP defines the distance by which the 2D shape is extruded (in the Z direction) to form the 3D extrusion volume
Using the Design Explorer navigate to the equipment element and select Create >
12.0 4:7
Using the Create Extrusion form, key in the Thickness of the extrusion and then select from one of the Create Methods
You can specify the position of a new positive or negative extrusion vertex (VERT) in a variety of ways. Click on the icon which corresponds to the method you want to use for the next point
In this example we have selected to create the extrusion by entering explicit coordinates, the Define Vertex form appears, click the Apply button and this will create the first vertex point. By clicking the F8 button this will toggle between wire line and shaded image.
Allows you to pick a point graphically using any of the standard cursor-picking methods
Allows you to identify a point by entering its explicit coordinates
Allows you to specify a distance and direction which define a point relative to the position of the preceding vertex
Allows you to construct a fillet arc with a specified radius between two picked tangent lines
Allows you to construct a fillet arc passing through three picked points
Allows you to construct a fillet arc with a specified radius, passing through two picked points, which curves towards a picked direction
12.0 4:9
The Extrusion Vertices have an attribute Fradius, if we change this for the vertex 2 and 3 then this will modify the extrusion as shown.
4.2.7
Creating a Revolution
This lets you create a positive or negative volume by rotating a user-defined loop (a 2D profile) through a specified angle around a given axis. The Axes controls let you define the axis about which the loop will be rotated, and the plane in which the loop is defined (the start of the generated shape).
Note: When you display the form, you will automatically be in event-driven graphics mode
From the main menu bar select Utilities > Constructs, the 3D Aid Constructs form appears, now select Create > Line > Explicit.
The Modify Line form appears, and also in the graphical view a line is shown, select the position of the line and the length. This is the start position which we will use as the rotational axis. Click OK to confirm the lines position and length.
12.0 4:11
The +ve Revolution form appears, in the Settings area, enter the Angle through which the loop is to be rotated. You can either type the angle in explicitly, or use the right button mouse menu to derive the angle by picking existing design items. From the Axes section select
Rotation Line, in the prompt area of the screen a message tells you to Pick line to rotate
about. Select the line previously created and this will be our axis.
Now on the +ve Revolution form the Point on Plane button is active, select the Point to
The Explicit Position form appears, key in E 100.00, N 0.00, U 0.00 this is the plane in which the loop is defined (the start of the generated shape). The Create section on the +ve
Revolution form is now displayed, select Pick points. In the graphical view it now shows the
rotational line and the start position for the shape.
The Positioning Control form is displayed once again, select explicit position.
The Explicit Position form is now displayed. Key in the values for the position of each Vertex, clicking Apply for each new position.
12.0 4:13
Once all the Vertex positions have been entered, click the OK button on the +ve Revolution form and the Revolution primitive is created.
The Revolution Vertices have an attribute Fradius, if we change this for the vertex 3 and 4 then this will modify the extrusion as shown
12.0 4:15
4.2.8
Checking the P-point Position of a Primitive
You will need to know how to check that it is correct when you have built it. You can check this co-ordinate by checking the position of the appropriate P-Ppoint, which is associated with each of the edges. Those for a box are reproduced as follows for convenience.
The P-Points are in the centre of each face apart from the origin of the box, P0, which is in the centre of the box.
The way of checking the box P-Points is to use the Query > General menu and select the P-Points option to check each of the individual points in turn. By default, all querying will be done relative to the equipment, but you can select world, site or zone options as well. Any mistakes made need to be corrected. The errors you are likely to have made will only be in the areas of position, size or orientation, so you should try to use the appropriate menus to make corrections.
4.3
Creating Nozzles
A nozzle is an interface point between the equipment and the connecting Pipework. Nozzles are positioned and oriented (and given a height dimension) like other primitives, but must be selected from the catalogue via a Specification (for the bore to be assigned).
The function is available when you select the Equipment Application, from within the DESIGN Module, and select Create > Nozzles.
4.4
Creating Electrical Components
An electrical component in equipment, is a connection point between equipment and cables and can represent anything from an individual cable gland to a piece of electrical equipment, such as a generator. Electrical components must be selected from the catalogue via a Selection Table. They are positioned and orientated within equipment in the same way as nozzles and primitives.
Select Create>Electrical Component from the main pull down menu to display the Create
12.0 4:17
The form lets the user select an electrical component from the range of catalogue items available. To name the component, either enter a Name explicitly, or use the Autoname option.
If the project has been configured with User Defined Element Types based on electrical component (ELCONN) element type, they will appear in the User Defined Type list. When the electrical component element is created, it will be created as the User Defined Type selected from this list. Selecting a User Defined Element Type may change the content of the Selection Table if the table has been configured to filter on element type.
Select the overall category of electrical component by choosing one of the Table options. This table may be divided into sub-categories selected using the Type options and can be sorted and filtered to restrict the number of components displayed for selection.
A component in the table can be selected by clicking on a row in the table. Clicking on the
Properties button displays the Modify Properties form on which to set any parameterised
data relevant to the selected electrical component.
Note: If the user does not set these, default values will be applied.
If no parameters are required for the selected component, then a message 'There are no properties to set' is displayed.
The Plotfile button will display a diagram of the component if one has been provided with the component definition. This diagram can also form part of the Modify Properties form. When the user has fully specified the electrical component, click Create. The component is then created at the equipment origin. A Component Position panel is displayed at the bottom of the form and is used to place the component in the required position by entering the coordinates of the component, or by using event-driven graphics positioning to place the component using the graphics cursor to pick a position in the 3D view.
When the new component has been positioned, click the Next button to create another component or Dismiss to close the form.
To orientate the component use Orientate>Rotate or Orientate>Axes functions on the main menu bar.
4.5
Create Equipment Form
This form lets you select any standard equipment item from the range of parameterised design templates available to you.
If you want to name the equipment, either enter a Name explicitly, or (if autonaming rules have been set up) use the Autoname option.
12.0 4:19
Standard equipment may be selected from a Specification or from a Selection Table as configured in the Equipment catalogue.
If equipment is selected from a Specification, a question-and-answer sequence is used to navigate down through the selection hierarchy until a unique design item is specified.
From the Specification options, select the overall category of equipment from which you want to select.
The Current Selection list (initially empty) shows your current level of selection detail, while the lower list (whose title changes to reflect its content) shows the options available from the current level. Select an item from the lower list to move down to the next selection level, repeating this process until you have fully specified a component. When you reach this stage, the title of the (empty) lower list will say Selection complete and the Current
Selection list will show all details of the selected equipment item.
If you set Auto Select to On, selection will be made automatically when there is only one available choice at any particular level.
If equipment is selected from a Selection Table, a table of available components is shown. This table can be sorted and filtered to restrict the number of components displayed for selection.
12.0 4:21
A component in the table can be selected by clicking on a row in the table.
The Properties button, which was greyed out during the selection process, is now active so that you can confirm the selection. When you click this, you will see a Modify Properties form on which to set any parameterised data relevant to the selected equipment. (If you do not set these, default values will be applied.)
The Plotfile button will display a diagram of the equipment if one has been provided with the component definition. This diagram may also form part of the Modify Properties form (depending on your current Properties Settings).
When you have fully specified the equipment, click Apply. You will now see a Positioning
Control form, showing that you are in event-driven graphics mode: use the facilities
provided by this form to pick the position of the equipment’s origin and complete the creation process.
4.6
Creating Equipment Points
This will allow you to create a design pointset if none exists, this also lets you create or modify the design points for a template. Each type of design point is stored in an appropriate element (DPCA= Cartesian; DPCY=Cylindrical; DPSP=Spherical) owned by a Design Pointset (DPSE). This will also allow you to create points that will be used for the equipment associations.
Using the Design Explorer navigate to the element that requires new points to be added, then from the pull down menu select Create > Points, the Design Points form is displayed.
The form lets you build up and edit a list in which each line represents one design point. All editing options are controlled from the form’s own menu bar; Create, Modify and Delete. To create a new design point, select the required point type from the Create menu. The options are:
From the Design Points form, Select Create > Cartesian. The Create Cartesian Design
Points form appears. Click the Connection button to set the connection type, the Point
Connection form appears in this case we are selecting the FBW (Flange Butt Weld) then click the OK button.
Back on the Create Cartesian Design Point form, from the Point Direction section key in the Direction of Design Point (Z) E and the Normal direction (Y) S.
Now from the form in the Positioning section click the Pick button, the Positioning Control form appears, put the settings to Ppoint and Snap.
Holding down the left mouse button over the equipment pick the Ppoint to snap to.
Cylindrical Point Specified as position on surface of cylinder at given position and with given dimensions
Spherical Point Specified as position on surface of sphere at given position and with given dimensions
12.0 4:23
The Design Points form now shows the newly created point and also the element shows the DP1 point and in the Design Explorer.
12.0 5:1
5
Modifying Equipment
5.1
Modifying Equipment Specifications
This function lets you change the specification to which the current element is associated. The function is available when you select the Equipment Application, from within the DESIGN Module, and select Modify > Equipment Specification.
5.1.1
Plotfile Form
This form lets you view a plot of the current element.
Specification Data group
Specification pulldown options are: • CADC Standard Equip
• CADC Advanced Equip • Reload
This group shows the equipment currently selected and those already defined as standard equipment types.
The Specification pulldown options are: • CADC Standard Equip
• CADC Advanced Equip • Reload
The Auto Select tickbox automatically selects a single entry when it is the only one available at any particular level
Properties Open the Modify Properties form that lets you change the properties for the current element
Plotfile Opens the Plotfile form showing a plot of the equipment being modified
12.0 5:3
5.1.2
Modify Properties Form
This form lets you change the properties for the current element that is shown highlighted at the top of the form.
Typing the new value in the required field to change it. All values may be reset to their original values by selecting the Reset button or the value may be changed to the default values by selecting the Default button.
Select the OK button to save the changes and close the form or select the Cancel button to close the form without saving any changes.
5.2
Modifying Nozzle Specifications
This form lets you change the nozzle specification.
The function is available when you select the Equipment Application, from within the DESIGN Module, and select Modify > Nozzle Specification.
5.3
Modifying Electrical Component Selection
The Modifying Electrical Component Selection function lets you change the specification to which the current electrical component element is associated. It is accessed by selecting
Modify > Electrical Component from the Equipment application main menu bar.
The component selection part of this form is similar to the Electrical Component creation form. The main differences between this form and the creation form are that the component name is not modified on this form (use Modify > Name) and the component is not positioned using this form (use the Position menu options or the Equipment model editor).
5.4
Modifying Primitives
In Equipment Editing mode, individual member primitives (including negative primitives) can be modified graphically using the standard movement handles.
Note: You do not need to be in the Equipment application to be able to use the graphical
equipment editing facilities.
To enter equipment editing mode and edit an equipment primitive. Enter Model Editor mode by select the Model Editor icon from the Model Editor Toolbar.
Specification Lists the specifications that have been associated with the current element
Generic Type Items in the pulldown list are generic types that have been set for nozzles within the Generic Type Definitions form of the PARAGON Module (see
the Catalogue and Specifications User Guide)
Nominal Bore Items in the pulldown list are set within the Nominal Bore Table within the PARAGON module (see the Catalogue and Specifications User
Guide)
SpecRef A pointer from a design element to a Catalogue Specification, which in turn points to that catalogue item which best meets the requirements of the element in the design.
12.0 5:5
Right-click on the equipment and from the pop up menu and select Edit Equipment. Notice how all other elements except the selected Equipment become translucent in the display. If the Equipment is built up using sub-equipment then right-click on the equipment once again and from the pop up select Edit SubEquipment.
To leave equipment editing mode, right click on the active equipment and from the pop up select Exit Equipment Editor.
Whilst in the equipment editing mode and primitive selected will display the Model Editor Modification handle. This modification handle works on the individual primitives in the same way as it worked on the equipment element, allowing linear, planar and rotational movements for each individual primitive.
5.4.1
Modifying Stretch / Trim a Primitives
Lets you stretch (increase) or trim (decrease) the dimensions of the constituent primitives of an equipment.
To stretch or trims a primitive by moving one of its p-points, which must be on an 'end' of the primitive, to the position of another p-point, which can be on another primitive or (trimming only) the same primitive. The user must select the primitive i.e from the design explorer.
Select Modify > Stretch/Trim > To P-Point and use the cursor to pick the p-point to be stretched / trimmed.
12.0 5:7
Now use the cursor again to pick the p-point to stretch / trim the first p-point to. A Confirm dialogue box appears asking ‘Return CYLI to original size and position?’. Click No.
Note: If two edge p-points on the same primitive are selected, the distance between the
two points will become zero. The procedure cannot be used to invert a primitive and the procedure is not applicable to nozzles or toruses.
5.4.2
Sliding a Primitive
The facilities available from this submenu let you slide (move) the current element in the direction of a selected p-point.
Select Modify > Slide > To P-Point and use the cursor to pick the p-point to be slid (moved) Now use the cursor again to pick the p-point to slide the first p-point to.
A Confirm dialogue box appears asking “Return CYLI to original position?”, click No.
5.5
Modifying a Design Item’s System Attribute
Using the Design Explorer navigate to the Equipment that requires its design system to be modified, then select Utilities > Systems. The Modify Design System form appears with the Main Systems tab visible, click on the System Add button.
The System Explorer form is now displayed, navigate to the system required and then click the OK button. The Modify Design System form in now updated to show the new system. There is also a Description and function field that can be populated if required.
The Owning tab is for information only, this shows the current systems and also if the item is part of a system by ownership e.g. the status could display Owning System.
12.0 6:1
6
Deleting Equipment
6.1
Deleting an Equipment
Using the Design Explorer navigate to the Equipment to be deleted, click the right mouse button and from the pop up menu select Delete, or select the Delete CE from the Default Toolbar or by selecting Delete > CE from the pull down menu.
A Confirm form appears, asking if it is Ok to delete the equipment? And the equipment is highlighted in the graphical view. Click Yes. The equipment is deleted from the design explorer tree and the graphical view.
Note: If an equipment / primitive has been deleted by mistake and the changes have not
yet been saved then by clicking the Undo icon from the Model Editor Toolbar, the equipment / primitive will brought back and visible in the Design Explorer and the graphical view once again .
6.2
Deleting an Equipment Primitive
Using the Design Explorer navigate to the primitive to be deleted, click the right mouse button and from the pop up menu select Delete, or select the Delete CE from the Default Toolbar or by selecting Delete > CE from the pull down menu. The primitive to be deleted is then highlighted in the graphical view.
A Confirm form appears, asking if it is ‘Ok to delete the primitive?’ Click Yes. The primitive is deleted from the design explorer tree and the graphical view.
12.0 7:1
7
Parameterised Design Template Equipment
Parameter expressions allow the result of an expression to be based on a conditional test
(If, Then, Else). This expression function will take the form:
IF(<Boolean Expression>, <True Expression>, <False Expression>)
12.0 7:3
Since IF is a PDMS expression function, it can be used within a PDMS expression according to the normal rules for use of functions inside PDMS expressions. Therefore the <True Expression> and <False Expression> can contain IF function calls, which allows simple nested conditional statements to be constructed.
7.1
Equipment Assembly Modelling Options
The best approach to modelling equipment depends on your requirement for data to be extracted from the model.
The simplest approach to modelling Equipment is to create an Equipment element in Design, and create a collection of primitives and nozzles under the Equipment element. In this case, no Design Template is used. This approach may be suitable for unique Equipment items that are not reused in the same project or in other projects.
In order to model an Equipment item containing Pipe and HVAC connections, and support steelwork, where the Equipment can be selected via an Equipment specification, it is necessary to create an Equipment Template.
12.0 8:1
8
Equipment Associations
Before you can create an equipment association we must first create an Association World (ASSOWL) and an Association Group (ASSOGP). If this is not done then the following error will be displayed.
From the command window key in NEW ASSOWL /BASIC_ASSOCIATIONS and NEW ASSOGP /BASIC_ASSOCIATIONS_GROUP
From the pull down menu select Utilities > Equipment Associations, the Equipment Associations form appears. Click the Select Association item and then pick an element to associate with. In this case pick the equipment YY9992.
The Make a new association section of the form is now active.
There are several different association types that can be selected, the association types are:
In this case we are making a new association using the Align, select the Align radio button and then click the Select new Association partner.
12.0 8:3
The 'associations between those objects' section of the form is now active.
Enter an Association Name and Separation value. In the example screenshot the
/BASIC_TEST name is entered. Tick the Measure Association tick box and select the Create Association button to display the test measurement result.
To navigate to the association, right-click on the item and select Navigate To in order to highlight it in the Design Explorer window.
12.0 8:5
12.0 9:1
9
Equipment Reporting
The Equipment Report lets you view and sort the Attributes of the Current Element.
The report is available when you select the Equipment Application, from within the DESIGN Module, and select Utilities > Equipment Report to open the Equipment Report form.
There are three stages to populating and viewing the report:
• Define the Attributes to appear in the report. This is done within the Columns Tab. Attributes that you place in the right hand pane appear in the report, under the Output Tab.
• View and sort the report. This is done within the Output Tab. • Save and view the report in excel.
When the form is opened the Columns tab is visible showing all of the Attributes and values for the current element. The right hand pane appears empty until you select Attributes from the left hand pane. The available attributes are: Attribute, Description, Data Type, Report Header.
The Pseudo Attributes checkbox allows you to display the pseudo names rather than the system names for each attribute.
9.1
Selecting the Attributes to Appear in the Report
Within the left hand pane of the Column Tab appear all of the attributes for the current element. In order for an attribute to appear in the output report an attribute needs to be added to the attribute list in the right hand pane. Highlight an Attribute by clicking on it. To select more than one attribute:
• Click on the first of a series of attributes and then using the [SHIFT] key select the last attribute in the series. This highlights a group of adjacent attributes.
• Click on an attribute and using the [CTRL] key select another non-adjacent attribute. Repeat to highlight other non-adjacent attributes.
Once you have highlighted the attributes that you wish to appear in the report use the ‘selecting’ arrows that appear between the left and right hand panes. These are:
> includes the highlighted attributes within the right hand pane
>> includes all of the attributes in the left hand pane, regardless of if any attributes are
highlighted
9.2
Removing Attributes from the Report
If an attribute appears in the right hand pane then it will appear in the report when you select the Output Tab. To remove an attribute from the right hand pane, and hence from the report, highlight it by selecting it and select the < arrow between the left and right hand panes.
To remove all of the attributes from the report, select the << arrow between the left and right hand panes.
9.3
Sorting Attributes in the Report
The right hand pane of the Column Tab shows the attributes in the order that you selected them from the left hand pane. If you want to change the order of these, highlight the attribute to move in the list by clicking it. Then select the {down} or {up} arrow to move it one place lower or higher in the list. Repeat this to move it further down or up the list.
9.4
Viewing and Sorting the Report
Note: Currently ALL equipment items in the current MDB are reported on. There is no
selection option at the moment as in the future it would be expected to be able to populate the list of required equipments from the search form.
Once you have compiled the list of attributes to appear in the report and moved them to the required position in the right hand pane of the Column Tab you are ready to view and sort
12.0 9:3
The report may be manipulated to show the attributes in a variety of ways: • Grouped
• Filtered
9.5
Grouping Attributes in the Report
The top part of the report contains a header field that lets you group attributes by column headings.
To set the grouping criteria click on a column heading and drag it on to the header field. The report changes to display the unique items that appear within the selected column. Against each of these appears a ‘plus’ icon which, when selected, expands to show the items that have that item in common.
To remove the grouping select the column heading from the header field and drop it on to the list underneath.
9.6
Filtering Attributes in the Report
Each column heading may be filtered to show entries that match the filter criteria. Select the icon on the left hand side of the column heading to display the pulldown list of filter criteria options.
To filter a column select the icon on the column heading to display the pulldown filter list. Select the required filter criteria from the list. The report changes to show the results of the filter selection.
9.7
Saving the Report
When the report is in the format required it can be save to excel by using the SAVE button. This brings up the Equipment Report Filename to allow you to name the file and place it in the required directory.
12.0 10:1
10
Copying Equipment
Rather than create another standard equipment item or even just an equipment created with primitives, we can use the copy facilities in the equipment application to create a duplicate pump and then rename it to become a unique element. Using the Design Explorer navigate to the equipment to copy. Then select Create > Copy > Offset \ Rotate \ Mirror from the main pull down menus. The following form will be displayed. Key in the Number of Copies and the Offset required, then click Apply.
The Object to copy can be CE, List or Pick. The copy to option can be CE or Rel. which means relative (the same position in the hierarchy as the copied item).
Use Modify > Name to change the name of the equipment to YY9995, and the nozzles to YY9995/N1 and YY9995/N2.
12.0 11:1
11
Working with Equipment
11.1
Axis System
The compass axis system used i.e. ‘NORTH4500 EAST3000 UP8000’ you can also use orientations like ‘NORTH 45 EAST’ or ‘UP 45 SOUTH 15 DOWN’. You need only give the first letter of these directions, i.e. N, S, E, W, U, D, and you do not usually need spaces between the different co-ordinate directions; thus N37.5 E27.3 U is a valid direction.
11.2
Positioning Control
There are four ways of setting the position attribute, Explicitly, Relatively, Using Ship References or by using the Model Editor. Selecting Position > Explicitly (AT) will display the following two forms.
The first is the Positioning Control form. By default this appears at the top right on the main menu bar but can be dragged to any position on the screen.
The Positioning Control Form (event-driven graphics) is shown automatically whenever you need to pick positions in event-driven graphics mode. It lets you specify how your cursor picks are to be interpreted as positions.
The Working Plane toggle provides a quick way of activating or deactivating the working plane. If set to On, all picked positions will be projected onto the current working plane.
The form has two option lists from which you can make the required selections.
Pick Type option lets you control the types of items to which cursor picking will respond. As you move the cursor over the 3D View, only items of the specified type will be highlighted as the cursor passes over them. The identities of highlighted elements are shown in the prompt bar, immediately above the graphical view.
The choices are:
Any You can pick any element, aid, Pline or Ppoint.
Element Picking is restricted to elements.
Aid Picking is restricted to drawing aids.
Pline Picking is restricted to structural P-lines.
Ppoint Picking is restricted to P-points.
Screen Lets you pick anywhere in the graphical view, which identifies two co-ordinates. The third co-ordinate is taken from the current Working Plane.
Graphics Lets you pick any graphical element (including aids, construction pins, etc.) that is displayed in the view.
12.0 11:3
The choices are:
Snap Selects the snap point nearest to the cursor pick point.
Distance Applies the offset value, which you enter in the adjacent text-box (e.g. 500 gives a point 500 mm from the nearest snap point, measured towards the cursor position; –500 gives a point 500 mm from the nearest snap point, measured away from the cursor position).
Mid-Point Derives the mid-point between two snap points along a linear item
Fraction Subdivides the distance between two snap points into a specified number of parts (as entered in the adjacent text-box). Then derives the fractional position closest to the cursor pick (e.g. 6 gives a point at the nearest sixth of the distance along the line joining the first snap point to the second snap point).
Note: The length of the picked item is subdivided into equal parts (6 in this example), each
of which behaves as a snap length in its own right. Thus the derived position is at the nearest integral fraction to the picked position.
Note: The value is expressed here as a proportion of the distance from start to end.
Note: Linear items picked here do not intersect. Derived position is at projected intersection
of second picked item onto first picked item, so order of picking is significant.
Proportion Derives the point whose proportional position between two snap points has been entered in the adjacent text-box (e.g. 0.25 gives a point 25% along the line joining the first snap point to the second snap point).
Intersect Lets you pick two lines (any directional items) or three planes and then it derives their intersection point.
Cursor Places the derived point exactly where the cursor picks on the element. The second form that is displayed is the Position Atas shown below.
12.0 11:5
This form lets you position an element either by typing in co-ordinates or by reference to the position of another design item.
Use of the Datum option allows identification of the specific point on the element to which the position is to apply, or to a Designate Position. If Designate Position is selected then you will be prompted to pick the position on the element using any of the facilities provided by the Positioning Control form.
To define a position explicitly, enter the required co-ordinates in the boxes, using the scrollable lists to set the appropriate direction in each case. If necessary, use the, WRT (with respect to) box to identify the element whose co-ordinate system is to be used for the Position data.
To define a position by reference to existing design items, use the Positioning Control form and the cursor to identify the required positions by picking them in a graphical view. If required, the Lock buttons can be used to fix the current co-ordinate along any axis.
To position another element, use the Select pull down menu options to change the focus of the form. Use the CE or Owner option if you have already navigated to the required item, or use the Pick or Pick Owner option and then pick the required item when prompted.
The form will display the current position and you can then change any part of this by entering new values. The position you give will be relative to the Datum, which may be the Origin or a selected ID Design point.
The Explicit Position button lets you bypass any graphical picking operation by entering an explicit position. Click it to display an Explicit Position form.
Selecting Position > Relatively (BY) will display the following menu, as well as the Position Control menu described earlier
12.0 11:7
11.2.1
Positioning Using P-points
All the primitives have a number of predefined points on their surfaces known as P-Points. For example, a cylinder has three P-Points, P0 (the origin), P1 and P2 at either end. P0 is normally used for general positioning whereas P1 and P2 are used for connecting or positioning relatively.
You can connect a P-Point on the current element to any other P-Point in the design. The act of connecting both positions and orientates the current element such that the two connected points are at the same position and facing each other. E.g. P1 on the cylinder connect to P4 on the box using Connect > Primitive > ID Point.
11.3
Positioning Equipment Point
The facilities on this submenu let you reposition an equipment element by repositioning a P-Point of one of its primitives (an Equipment P-Point).
11.3.1
At Explicit
From the pull down menu select Position > Equipment Point > At Explicit, in the lower left hand corner a screen prompt appears, asking Identify a point on YY9001. By depressing the left hand mouse button and hovering the cursor over the equipment the required point can be selected.
Once the point required is selected, the Position form is displayed, change the required directional value and click Apply the equipment is moved to the new position. If the new position is not suitable, the Reset button can be selected, this will set the equipment back to its original position. If the position is suitable and no further positioning is to be carried out click the Dismiss button.
