Paragon
Paragon
Reference Manual
Version 11.5
pdms1151/man15/doc1
Issue 140403
PLEASE NOTE:
AVEVA Solutions has a policy of continuing product development: therefore the information
contained in this document may be subject to change without notice.
While every effort has been made to verify the accuracy of this document, AVEVA Solutions
shall not be liable for errors contained herein or direct, indirect, special, incidental or
consequential damages in connection with the furnishing, performance or use of this material.
This manual may provide documentation relating to products to which you do not have
access or which are not licensed to you. For information on which products are licensed to
you, please refer to your licence conditions.
All rights reserved. No part of this document may be reproduced, stored in a retrieval
system or transmitted, in any form or by any means, electronic, mechanical, photocopying,
recording or otherwise, without prior written permission of Cadcentre.
The software programs described in this document are confidential information and
proprietary products of AVEVA Solutions or its licensors.
Note that the following notice applies to the AutoDRAFT menu files which are derived
from an original AutoCAD menu file:
Permission to use, copy, modify, and distribute this software for any purpose and without
fee is hereby granted, provided that the above copyright notice appears in all copies and
that both that copyright notice and this permission notice appear in all supporting
documentation. This software is provided ’as is’ without express or implied warranty.
For details of AVEVA’s worldwide sales and support offices, access our website at
http://www.aveva.com
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, UK CB3 0HB
Contents
1 Introducing PARAGON
1.1 What Does PARAGON Do? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1--1
1.2 About this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1--1
1.2.1 Manual Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1--2
10 Datasets
B Setting Up a Catalogue
B.1 Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B- 1
B.2 Example Connection Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B- 1
B.3 The Connection Compatibility Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . B- 4
Index
PARAGON enables you to generate or modify a PDMS Catalogue, with facilities for
constructing Catalogue Components under fully interactive visual control, including 3D
colour--shaded representations of the items being designed.
PARAGON combines aspects of both catalogue creation and model design functionality
within a single module. This means that a catalogue designer not only has write access to a
project’s Catalogue databases, but may also read data from the Design databases. If given
write access, the catalogue designer could also experiment with new catalogue component
configurations in a trial design database. This approach simplifies catalogue maintenance
and design. Similarly, it is often useful for a plant design engineer to have access to the
Catalogue to query details of specific components.
PARAGON has a Graphical User Interface consisting of forms and menus. The interface
provides access to the most commonly used facilities. To enter direct command syntax, use
the Display>Command Line menu option to open a special window which accepts
command inputs and displays system outputs. Full details of using PARAGON’s menus
and forms are given in the on--line help, and how to design your own graphical user interface
is explained in the Cadcentre Software Customisation Guide.
This document is a Reference Manual for PARAGON. It describes all of the PARAGON
keyboard--entered commands in detail. If you need information on how to use PARAGON to
carry out the principal Catalogue design activities with minimal use of the keyboard, by
using the graphical Forms and Menus interface, refer to the on--line help for the PARAGON
applications.
It is assumed that you have attended a PDMS training course and are familiar with the
basic concepts underlying the use of PDMS.
NOTE: The PARAGON and DESIGN modules share a common command syntax, but
differ in that PARAGON operates on a Catalogue database while DESIGN
operates on a Design database. Only the Catalogue construction commands are
explained in this manual; for details of commands for 3D design work, see the
PDMS DESIGN Reference Manual.
D Chapter 2 describes how to enter commands and the notation used to describe
commands.
D Chapter 3 describes how to enter and leave PARAGON and explains some general
facilities.
D Chapter 4 gives details of the Catalogue database hierarchy and the ways in which its
constituent elements are defined.
D Chapter 5 describes the ways in which you can navigate to any given element within
the Catalogue database.
D Chapter 7 gives details of the various types of point set (p--points and p--lines) and
geometry sets (positive and negative 3D and 2D primitives) which are used in the
design of catalogue components.
D Chapter 8 explains the procedures for defining the various types of element which
represent the design components within the Catalogue database.
D Chapter 10 explains the concept of datasets, used to store catalogue data which needs
to be queried from DESIGN or DRAFT and which is not accessible by other means.
D Chapter 11 describes how you can check the Catalogue database for inconsistencies
from within PARAGON, so that errors can be corrected before the data is used a design.
D Appendix C lists some sample macros for the design of typical piping components in the
Catalogue database.
2.1 Commands
This section describes the conventions used in this manual to describe commands to be
typed in from the keyboard. The description of each command follows a standard format
which is designed to allow the basic attributes of a command to be interpreted easily. To get
the best out of this manual, you are strongly urged to read this section thoroughly.
Once you have located the required command in this manual, you will find that it is
described in a standard format. This format is described below.
D Keywords This is a list of those PARAGON command words which are the prime
constituents of the command syntax which carries out the given function.
D Example(s) These are examples of typical command lines that show the effect of the
principal options. Special notes on the behaviour of the command in specific conditions
are given here.
D Command Syntax This shows the actual command with its possible options. The
notation used for commands is described below (Section 2.1.2).
The commands described in this manual have their legal command and interrogation
options presented in the form of syntax diagrams. These diagrams formalise the precise
command sequences which may be used and are intended to supplement the explanations
given in the appropriate sections of the manual.
D All diagrams have abbreviated names. Such names are composed of lowercase letters
enclosed in angled brackets, e.g. <expres>. These short names, which are used for
cross--referencing purposes in the text and within other syntax diagrams, are
supplemented by fuller descriptions where they are not self--explanatory.
D Commands to be input from the terminal are shown in a combination of uppercase and
lowercase letters. In general, these commands can be abbreviated; the capital letters
indicate the minimum permissible abbreviation.
NOTE: This convention does not mean that the second part of the command must be typed
in lowercase letters; commands may be entered in any combination of uppercase
and lowercase letters.
DEFault
DEF
DEFA
DEFAU
DEFAUL
DEFAULT
D Syntax diagrams are generally read from top left to bottom right.
D Points marked with a plus sign (+) are option junctions which allow you to input any
one of the commands to the right of the junction. Thus
means you may type in ABC or PQR or any command allowed by the syntax given in
diagram <dia> or just press Enter/Return to get the default option.
D Points marked with an asterisk (*) are loop--back junctions. Command options
following these may be repeated as required. Thus
.------<------.
/ |
>---*--- option1 ---|
| |
|--- option2 ---|
| |
‘--- option3 ---+--->
permits any combination of option1 and/or option2 and/or option3 (each separated by at
least one space) to be used. The ‘options’ may define commands, other syntax diagrams, or
command arguments). The loop--back construction may form an exception to the rule of
reading from top left to bottom right.
.----<-----.
/ |
>---*--- name ---+--->
means that you may type in a list of PDMS names, separated by at least one space.
Command Tool is a generic term covering command arguments (or atoms) and command
parts. Both classes of command tool fit into ordinary commands and provide different ways
of stating a particular requirement. Command tools may be PDMS--wide or
module--specific. This section describes the standard Command Tools that may be used in
PARAGON. They may be one of the following:
D External Macro Facilities -- which can be used in a stored macro file and which control
the behaviour of the macro when it is executed
Some of the main command tools (or the PARAGON variations of them) summarised for
convenience:
Command arguments are also called atoms because they cannot be broken down any
further. They are individual units which PARAGON can recognise as constituents of a
complete command. They usually need to be separated by spaces so that they are
individually distinguishable. Command arguments are distinguished from the other
command parts by being written in lower case italics. The principal command arguments
are:
value a signed number with or without a decimal point, e.g. 2.5 5 --3.8
space the space bar (not usually specified unless of special significance)
name a sequence of characters preceded by a / character and representing a PDMS
Element name, e.g. /VALVE1.
comma the , character, which can be used to concatenate PARAGON commands; for
example: NEW UNIT, BUNI INCH, DUNI FINC
plus minus the +, --, * and / characters, which can be used within
star solid expressions, for example: (1 + 2), (1 -- 2), (1 * 2), (1 / 2)
(Note that there must be a space before and after each of these command
arguments.)
Command parts are subsets of the general command syntax which are used frequently
within other command sequences. The following command parts are summarised here:
Expressions
Any mathematical, logical or alphabetical expression whose result replaces it in the
command syntax.
Dimensions
A physical dimension entered using default or explicit units.
If a value given within a command needs to be calculated from other known values, you can
enter an expression from which the required result is to be evaluated by PARAGON as it
executes the command. Such an expression must be enclosed between parentheses (...) to
identify where it begins and ends.
Full details of the expression syntax are given in the Cadcentre Software Customisation
Guide and Cadcentre Software Customisation Reference Manual, and are also available as
on-line help.
Once the working units have been specified, all dimensions input subsequently will be
assumed to be in those units unless you override them. (Note that these are simply specific
examples of the use of ‘real’ expressions. You can include explicit units of measurement
when entering a value in any expression.)
Examples
Piping Components:
SCOMponent COMPonent number
Profile Components:
SPRFile PROFile number
Joint Components:
SJOInt JOINt number
Fitting Components:
SFITting
(NOTE: FITTing number is not a valid option)
3D Geomset elements:
GMSEt SBOX SDIsc SDIsk
SCOne LSNout SDSH BOXIng
SSLCylinder SSPHere LCYLinder SCYLinder
LINes SCTorus SREVolution SRTorus
TUBe LPYRamid SEXTrusion SLOOp
SVERtex
3D Pointset elements:
PTSEt PTAXi PTCAr PTMIx
Dataset elements:
DTSEt DATA
Units elements:
UNIT MSET MTYPe ATLIst
USECtion UDEFinition
Specification World elements (see the VANTAGE PDMS PDMS SPECON Reference
Manual):
SPWL SPECi SELEc SPCOm
This command part identifies a specific element either explicitly or by reference to its
relative position in the database hierarchy.
Examples
This command part defines the most general method of identifying an Element. The
command is completed by picking an element using the cursor in a graphical view.
Examples
Keyword: PARAGON
At any point during a PARAGON session, you can elect to leave PARAGON and enter
another module of PDMS. This is simply a matter of inputting the name of the module to be
accessed. At this point, PARAGON will automatically save the results of the working
session and change to the new module. However, all graphical displays, forms and menus
will need to be redefined at the beginning of the next session. In order to avoid having to
redefine a view and screen layout, it is possible to save the current status of a working
session by use of the RECREATE command.
Description: If the intention is to leave PARAGON for a short period only this facility
allows the display definition and status (including the full forms and menus
set) to be saved, for restoration later.
NOTE: Forms resized or moved using the cursor will be INSTALLed to their original size.
Examples:
Command Syntax:
Description: These two commands are complementary. SAVEWORK lets you update the
databases to incorporate any changes you have made during your current
PARAGON session (since your last SAVEWORK). GETWORK lets you
refresh your view of all READ databases to pick up any changes that others
may have made since you first opened them.
Both commands can be restricted to specific databases within the current MDB by
following them with a list of numbers. These numbers represent specific databases in
the order they appear in the output of the STATUS command, which may be given in
ENTRY, MONITOR or in the MDB mode of any GUI module. If no database numbers
are given, then the commands apply to the whole MDB.
GETWORK automatically updates all volume views to reflect any changes in shared
databases.
Description: This command exits from PARAGON without saving any changes or the
display setup. QUIT has the effect of deleting any changes made since the
last SAVEWORK, module change or MDB change.
Examples:
Command Syntax:
Description: This facility lets you save the alpha display information to a text file in the
computer operating system. Two types of output are available, depending
on the command used.
ALPHA LOG enables the contents of either or both of the COMMANDS and
REQUESTS alpha regions to be written to a file.
ALPHA FILE enables the contents of the REQUESTS region only to be written to file.
The ALPHA LOG/ ALPHA FILE facilities may be used to save data or as a general
output facility.
NOTE: After an ALPHA file has been opened, subsequent output will be directed to both
the file and the screen until the file is closed, or until you change to another PDMS
module.
Examples:
ALP LOG /LF1 OVER COMM -- as above, but overwrite existing file /LF1
Command Syntax:
Description: Each alpha region may be cleared by using a variation of the ALPHA
command.
Examples:
ALPHA COMMANDS CLEAR Clears the text from the COMMANDS region only.
ALPHA REQUESTS CLEAR Clears the text from the REQUESTS region only.
(These commands will also affect alpha views which use the COMMANDS or REQUESTS
channel.)
Command Syntax:
Keywords: ALARM
Description: When a macro error occurs, there is an audible alarm at the workstation to
signal that the error has occurred. Occasionally, macro errors can be
anticipated and no audible warning is required. This command allows the
audible warning to be switched on or off either interactively or via a macro.
If the audible warning is ON, it will sound whenever an error alert is displayed.
Examples:
Command Syntax:
Keywords: TRACE
Description: This command, applicable in TTY mode only, controls the automatic output
of the Current Element name and attributes. With Trace set to ON, the
attributes display is automatically updated for each element accessed.
With Trace set to OFF, the attribute display is not changed. When macros
are being run, TRACE is always set to OFF automatically.
Examples:
Command Syntax:
Description: These commands allow colours to be defined so that the status of different
types of item in the display may be distinguished by means of colour. The
colours used have default settings, but these may be redefined.
The colours may be assigned by using the COLOUR command to define the
Red--Green--Blue mix for a colour number or to assign a predefined colour mix by
name. PARAGON allows the use of 100 user--definable colours, plus some specific
ones which are assigned to items which need to be readily distinguishable in the
display.
Definitions:
D The Active colour is used for the catalogue component being worked on (the
significant element, e.g. ELBO, VALV). If the current element is a geometric
primitive, the active colour is used for all primitives owned by the significant element
except the current primitive.
D The CE colour is used for the element currently being accessed (i.e. the element
highlighted in the Members list). This may be either a primitive or a significant
element.
D The Visible colour is used for any element in the display other than those to which the
active or CE colours apply.
D The Active and Visible elements together constitute the Draw List.
The predefined colour mixes which you may specify by name are as follows:
Colour No Colour
Current element yellow
Visible elements lightgrey
1 grey
2 red
3 orange
4 yellow
5 green
6 cyan
7 blue
8 violet
9 brown
10 white
11 pink
12 mauve
13 turquoise
14 indigo
15 black
16 magenta
Examples:
COL 3 MIX RED 50 GRE 50 BLU 5 Colour 3 will change to the specified mix of
red, green and blue
NOTE: When colours are mixed in their Red, Green and Blue constituents, the command
line must contain values for all three constituents in the correct order. The
numbers entered for the relative proportions of the basic colours must each be in
the range 0--100, but they are not percentages of the overall colour and so do not
need to add up to 100.
Command Syntax:
where colour_name is the name of any of the predefined colour mixes listed above.
Querying:
Note that words of four or five uppercase characters which appear in this chapter (for
example, CATA, BLTA, SPREF) are PDMS element names. When an element’s member list
is queried in PDMS, each element type will be displayed as a four--character name. Five or
six characters are occasionally used in this chapter where this gives a ‘PDMS’ name which is
closer to the element’s ‘English’ name, for example SPREF (instead of SPRE) for
Specification Reference.
The Catalogue in PDMS serves a purpose similar to a parts catalogue to which a pipework
designer or structure designer would refer when using ‘conventional’ design methods. It
contains details of all available components (piping and structural), including their
dimensions, geometry and drawing symbols. Whereas the conventional parts catalogue is a
book held in the Design Office, the PDMS Catalogue is a database held on the computer.
If a new Catalogue database (DB) is required, PARAGON can be used to construct it -- see
Chapter 8 for details of creating and manipulating a Catalogue DB using PARAGON.
The Catalogue data is held according to a strict hierarchy which is similar in form to that of
the Design data.
Whereas the Design data is specific to a particular design, Catalogues and Specifications
may be specific to a company but general to a number of projects in that company. For
example, the same Catalogue Component may be referred to many times in a particular
design and may also appear in other design projects proceeding at the same time.
Catalogues are usually built up as a library of catalogue macros. A selection of these macros
can then be used to build up a project--specific Catalogue database containing only those
Components which might be used on that project.
Note that in any discussion of attributes which may appear in the rest of this chapter, the
‘standard’ attributes of TYPE, NAME, OWNER and LOCK will not be mentioned, as these
are common to all the elements described below.
In addition, user- defined attributes (UDAs) may be used with Catalogue database elements
-- see the VANTAGE PDMS LEXICON Reference Manual for details.
WORLD
(Connections) (Bolts) (Units) (Specifications) (Groups)
SECT STSE
CATE STCA
GMSE GMSE MTEX SPRF SFIT GMSS PTSS GMSE NGMS PTSE SMTE
SCOM PTSE DTEX DTSE SJOI SDTE DTSE
SBOX BLTP SREC PLIN SBOX NSBO PTCA
BOXI PTCA DATA SANN BOXI PTAX DATA
LSNO PTAX SPRO LSNO NLSN PTMI
SCON SCON NSCO
SSPH PTMI SPVE SSPH NSSP
LCYL LCYL NLCY
SCYL SCYL NSCY
SSLC SSLC NSSL
SCTO SCTO NSCT
SRTO SRTO NSRT
TUBE TUBE
LPYR LPYR NLPY
SDIS SDIS
SDSH SDSH NSDS
LINE LINE
SEXT SEXT NSEX
SREV SREV NSRE
SLOO SLOO SLOO
NOTES:
For ease of interpretation in text:
SCOM = COMP
SPRF = PROF CATE/STCA (Category) elements are
SJOI = JOIN optional. Their members can be owned
SFIT = FITT directly by a SECT/STSE.
SDTE = DTEX
SMTE = MTEX TEXT elements, which can appear at
several positions in the hierarchy,
Any negative 3D primitive (as shown below NGMS) can have been omitted for clarity.
also be owned by any positive 3D primitive.
CATA is the highest level element of the Catalogue hierarchy. Its attributes include:
D PURP -- a PDMS word showing the specific purpose for which that catalogue is
intended. This should be set to the same word as the Specification with which it is to be
used; e.g. PIPE, FITT.
A CATA can contain a number of Catalogue Sections. These are of two types: Piping
Sections (SECT) and Structural Sections (STSEC). They are the principal
administrative elements by which the Catalogue is divided and arranged. The Catalogue
can also contain Text elements (TEXT) -- see Section 9.6.
All elements referred to in a Specification (see the SPECON Reference Guide) must exist
within a CATA hierarchy, although elements may exist within a CATA which are not
referred to by a Specification.
Note that the following elements may also exist within the Catalogue database at the same
level as CATA:
Units, Connection Tables and Bolt Tables are described in Chapter 11 of this manual, the
latter element type being described in more detail in the ISODRAFT Reference Manual.
Specification World elements are detailed in the SPECON Reference Manual.
Sections and Categories are administrative elements which let you segregate particular
types of catalogue data into logical parts of the hierarchy. Sections, which subdivide an
overall CATA, are obligatory; Categories, which subdivide Sections, are optional (although
their use is recommended).
There are two types of Catalogue Section: Piping Sections (SECT) and Structural
Sections (STSEC). Both have the following attributes:
D PURP -- a PDMS word showing the specific purpose for which that section is intended.
D GTYP -- a PDMS word showing the generic type for elements contained in the section.
This should be the same word as that used to identify the elements in DESIGN; e.g.
VALV, BEAM.
Similarly, there are two types of Category: Piping Category (CATE) and Structural
Category (STCA). Both have the following principal attributes:
D PURP -- a PDMS word showing the specific purpose for which that category is
intended. This should be set to the same STYPE as in the Specification with which it is
to be used; e.g. GLOB, GATE etc. for a VALV.
D GTYP -- a PDMS word showing the generic type for elements contained in the section.
D SKEY -- a textual symbol key showing how the item is represented in isometric
drawings (see the ISODRAFT Reference Manual).
Both types of Catalogue Section or Category contain the elements 3D P--point Set, 3D
Geometry Set, Data Set, Detailing Text and Material Text, as described in Section
4.5.1. Piping Sections/Categories may also contain Piping Components, as described in
Section 4.5.2. Structural Sections/Categories may also contain Structural Components
(Profiles, Joints and Fittings), Structural Pointsets, Negative 3D Geometry Sets
and Structural Geometry Sets, as described in Section 4.5.3.
The following elements may be used in either type of Catalogue Section or Category:
D Material Text (MTEX) -- elements containing text describing the material(s) from
which the physical Component is constructed. Referred to from SPCOM elements in the
Specification. For further details see Section 9.2.
A Piping Section or Category may contain all those elements listed in Section 4.5.1 plus the
following:
A Structural Section or Category may contain all those elements listed in Section 4.5.1 plus
the following:
Geomset make use of the component parameter values in defining the size and
geometry of the Component. In the design process, a length is associated with a Profile
to produce a Section.
The Catalogue structure as described so far may be used in various ways, but the
recommended method of use is to place only one type of element in each Catalogue Section,
and to place different kinds of Components in different Catalogue Categories. For example,
you might place all 3D Pointsets for Piping Components in one Piping Section and all 3D
Geomsets for Piping Components in another, with separate Piping Sections for equal tees
and reducing tees. When defining Profiles, you might place Profiles for Universal Beams in
one Structural Section, Profiles for Unequal Angles in another, and so on.
The Text is a general element that can occupy many positions in the hierarchy. It can be
used to store additional information about an owning or adjacent element. The TEXT
element should not be confused with the MTEX and DTEX elements described in Section
4.5.1. See Section 9.6 for further details.
4.7 Parameters
Parameters define the size, geometry and other characteristics of Components. They are
used in setting the attributes of the Pointsets, Geomsets and Datasets to which Component
elements refer.
All classes of Component can use component parameters, design parameters and
insulation parameters. Structural Components can also use attached and owning
design parameters. Component parameters are defined in the Catalogue; the other
classes of parameters allow characteristics to be set during the design process.
Piping Components (COMP), Profiles (PROF), Joints (JOIN) and Fittings (FITT) all have a
PARAM attribute which lists the component parameters.
Section 8.2 describes how to set up the component parameters of a Component. You may
define default values which PARAGON will use if you are working with a Component whose
component parameters have not been set up. The values are set using the MODEL
SETTINGS command. For example,
defines a default value of 10 for component parameter number 1. See Section 6.4.1 for the
full syntax of how to set default values.
These default values are set up only for the current PARAGON session. They are not stored
in the Catalogue DB. You must define the component parameters of a Component before
you use it in the Design DB.
A design element in the Design DB refers to a main Catalogue Component (indirectly) via
its Specification Reference (SPREF) attribute. The design element may also refer to a
second Catalogue Component which defines the insulation of the first Component, via its
Insulation Specification (ISPEC) attribute. The second Component is the Insulation
Component of the design element.
Insulation parameters (IPARAM) allow the main Component to take dimensions from the
Insulation Component. When the main Component uses IPARAM 3, for example, it picks up
the value of the PARAM 3 of the corresponding Insulation Component.
When you define a Catalogue Component using insulation parameters, its dimensions are
not completely specified in the Catalogue. So that PARAGON can give some idea of what the
Component will look like when used in a design, you can define specimen values for the
insulation parameters. These specimen values apply to all Components, unlike the
component parameters which are attributes of a particular Component. The values are set
using the MODEL SETTINGS command. For example,
defines a specimen value for insulation parameter number 3. See Section 6.4.5 for the full
syntax of how to set values for insulation parameters. The values are not stored in the
Catalogue DB; they are set up only for the current PARAGON session.
These allow Joint and Fitting Components to take dimensions from the Section or Sections
(beam, column, etc.) to which they are physically connected. In this way, a basic design of
Joint or Fitting may be adjusted automatically in the Design DB to fit a connected Section of
any size. (Structural parameters are meaningless for Profiles.)
The types of structural parameter that a Component can use depends on whether it is a
Piping Component, Profile, Joint or Fitting. In the case of a Joint, it also depends on how the
Component is used in the Design DB.
Joints are of two types: primary and secondary. A primary Joint has an attached Section in
the Design DB; a secondary Joint has an attached Section and an owning Section. (See
the VANTAGE PDMS DESIGN Reference Manual for details of primary and secondary
Joints.) Note that primary and secondary Joints are represented by the same class of
Catalogue Component, but the settings of their attributes and the attributes of their
Pointsets and Geomsets are different.
Components which have an attached Section (i.e. primary and secondary Joints) can use
attached parameters to define the attributes of their Pointsets and Geomsets. Attached
parameters correspond to the component parameters of the attached Section. For example,
when a Joint component uses APARAM 2, it picks up the value of the PARAM 2 of the Joint’s
attached Section.
Similarly, Components which have an owning Section (i.e. secondary Joints and Fittings)
can use owning parameters in defining the attributes of their Pointsets and Geomsets.
Owning parameters correspond to the component parameters of the owning Section. For
example, when a Joint or Fitting component uses OPARAM 5, it picks up the value of the
PARAM 5 of the component’s owning Section.
You can define specimen values for structural parameters in the same way as for insulation
parameters. For example,
defines a specimen value of 300 for attached parameter number 2. See Section 5.9 for the
full syntax of how to set values for structural parameters.
These allow structural Components to take dimensions from Design Parameter Arrays in
the Design DB. Each design element has a Design Parameter Array with ten values. (See
the VANTAGE PDMS DESIGN Reference Manual for further details.)
Design parameters allow any component with an SPREF to use values from the design
element which refers to it (via the SPREF). For example, the DES PARAM 4 of a Component
is the fourth value in the Design Parameter Array of the design element. Design
parameters can be used anywhere that component parameters can be used.
Design attached parameters and design owning parameters allow a Joint or Fitting
Component to use values from the design elements which represent its attached and
owning Sections. (Attached and owning sections are explained in Section 4.7.3.) For
example, the DES OPARAM 1 of a Component is the first value in the Design Parameter
Array of the design element of its owning Section. Design attached parameters can be used
anywhere that attached parameters can be used. Similarly, design owning parameters in
place of owning parameters.
You can define specimen values for Design DB parameters in the same way as for insulation
parameters. For example,
defines a specimen value of 9.5 for design parameter number 7. See Section 6.4.1 for the full
syntax of how to set values for Design DB parameters.
Figure 4--3 summarises how the various types of parameters may be used with the different
classes of Component.
D Piping Component
D Profile
D Joint
D Fitting
Their attributes are described in the following sections. These attributes (other than the
component parameters) must be set to actual values (words or references to other
elements). They cannot be defined using parameters.
A reference to an element is usually set to the name of the element, for example /PTSR3, but
it can also be set as a general identifier, for example:
The attributes of Pointsets and Geomsets may be defined using component parameters,
design parameters and insulation parameters. Where appropriate, attributes for
structural items may also be defined using design owning parameters and design attached
parameters.
A component parameter may be a numeric value, an expression or a word. (The full syntax
for expressions is defined in the Plant Design Software Customisation Guide.) An insulation
parameter, a structural parameter or a Design DB parameter may only be a numeric value
or an expression. The values assigned to parameters and the use to which they are put, and
the number of parameters used, are arbitrary, depending only on the skill and experience of
the user. Chapter 8 contains examples of the parameterisation of typical Components.
D PARAM -- the component parameters, a list of values used in the 3D Pointset and 3D
Geomset to define the Component.
D GTYPE -- a word attribute indicating the generic type of the Piping Component,
selected from the following:
ATTA -- attachment
BEND -- pipe bend
CAP -- end cap
CLOS -- closure
COUP -- coupling
CROS -- cross piece
DUCT -- ducting
ELBO -- fitting elbow
FBLI -- blind flange
FILT -- filter
FLAN or FLG -- flange
FTUB -- fixed length tube
GASK -- gasket
HELE -- hanger element
INST -- instrument
INSU -- insulation
LJSE -- lap joint stub end
NOZZ -- nozzle
OLET -- weldolets
PCOM -- pipe component
REDU -- reducer
SHU -- standard hook--up
TEE -- fitting tee
TRAC -- tracing
TRAP -- steam trap
TUBE -- implied tube
UNIO -- union
VALV -- valve
VENT -- open--ended pipe or vent
VFWA -- four--way valve
VTWA -- three--way valve
WELD -- weld
The GTYPE must be set as one of the above, otherwise a data consistency check
on a Branch containing the Component (see the VANTAGE PDMS DESIGN
Reference Manual) will not work correctly.
D PARAM -- the component parameters, a list of values used in the Structural Pointset
and Structural Geomset to define the Component.
D GTYPE -- a word attribute indicating the generic type of the Profile. Any word value
may be used. The following are suggested:
BEAM -- beam
BRAC -- brace
COLU -- column
GANT -- gantry
GIRD -- girder
JOIS -- joist
PILE -- pile
PROF -- profile
PURL -- purlin
RIDG -- ridge
SDRA -- side rail
D PARAM -- the component parameters, a list of values used in the Structural Pointset,
3D Pointset and 3D Geomset to define the Component.
D GTYPE -- a word attribute indicating the generic type of the Joint. Any word value may
be used. The following are suggested:
BASE -- base
JOIN -- joint
KNEE -- knee
D CTYA -- a word attribute indicating how the Joint is fixed to the attached Section (the
Joint’s connection type for the attached Section). Any word value may be used. If the
connection type attribute of the attached Section (CTYS or CTYE) has not been set
when the Joint is selected in the design process, the attribute will automatically be set
to the value of CTYA. The PDMS data consistency checks (see the DESIGN Reference
Manual) check whether the connection type attributes of the Joint and attached
Section match.
D CTYO -- similar to CTYA, but for the Joint’s owning Section (secondary Joints only).
D PARAM -- the component parameters, a list of values used in the Structural Pointset,
3D Pointset and 3D Geomset to define the Component.
D GTYPE -- a word attribute indicating the generic type of the Fitting. Any word value
may be used, but the word FITT is suggested.
D CTYA -- a word attribute used only if the Fitting is attached to a pipe hanger in the
Design DB. Any word value may be used. If the connection type attribute of the pipe
hanger (HCON or TCON) has not been set when the Fitting is selected in the design
process, the attribute will automatically be set to the value of CTYA. The PDMS data
consistency checks (see the VANTAGE PDMS DESIGN Reference Manual) check
whether the connection type attributes of the Fitting and pipe hanger match.
NOTE: For details of the MODEL SETTINGS command syntax used to set default values
for component parameters, and specimen values for other classes of parameter, see
Section 6.4.1.
There are many ways in which you can explore the contents of the Catalogue database, but
they fall into three broad categories:
D Accessing a Catalogue element whose identity or hierarchical position is known
D Accessing a Catalogue element whose position in the hierarchy relative to the current
position is known
D Accessing a Catalogue element by picking it from the screen
It is important to appreciate that these navigation facilities provide you with access to the
complete Catalogue and not just those items shown on the graphical display.
In graphical form, you can jump straight to an element which is shown in the screen display
by positioning the cursor over the element and pressing the left--hand mouse button. This
identifies the item under the cursor and makes it the current element.
Alternatively, the cursor can be used in the Members menu (or the command window) to
pick a name from the text display.
You can jump straight to a known element simply by typing its name. You would usually
name an element when you create it.
All elements are automatically given a reference number when created. By stating this
reference it is possible to access an unnamed element. Reference numbers are not normally
shown in PARAGON, but may be obtained by the using the Q REF command.
Keywords: SAME CE
Description: SAME takes you to the element you were at before you accessed the current
element. Repeating the SAME command has the effect of moving
repeatedly between two items -- it does not move back along the list of items
accessed.
If the previously accessed element has been deleted, the SAME command
will output an error message.
CE takes you to the current element itself. (This facility may seem rather
pointless in this situation; however the CE keyword is used in many
commands as a means of identifying an element to be the object of that
command.)
Example:
ADD CE -- Add the current element to the display.
Command Syntax:
>-- CE -->
>-- SAMe -->
Description: Moving up the hierarchy involves fewer decisions than moving downwards,
as any element can have only one Owner. Two commands (OWNER and
END) allow you to move up to the immediate parent.
It is possible to ascend the hierarchy in more than one step, by inputting the
type of element you wish to access. For example, to navigate from a Piping
Component to its Section would involve two successive END commands (if
a Category exists). However the command SECT would have the effect of
scanning up the hierarchy to find the Section which owns that list, thus
saving an END command.
Keywords: GOTO
Examples:
Command Syntax:
where <refatt> is the name of any reference attribute of the current element whose setting
points to another element.
Description: Most of the above commands can be linked together with the OF keyword to
produce general navigation commands.
Examples:
Command Syntax:
This chapter introduces the methods of Component design and graphical representation in
PARAGON; in particular the MODEL, MODEL SETTINGS and REPRESENTATION
commands are detailed.
Assuming that you have opened a suitable 3D view, the interactive graphical Component
design process in PARAGON is initiated using the MODEL command.
If a new Component is to be designed, then a new catalogue element must first be specified
by a command such as
NEW SCOM /CR2--1 (at SECT or CATE level)
or
NEW SPRF /UB4--A (at STSEC or STCAT level)
The command
MODEL CE
(for ‘Model Current Element’) will add the new component to the 3D view.
Only complete Components may be displayed in this way -- individual Pointsets and
Geomsets may not be, although these items will easily be distinguishable, especially on a
colour terminal. (Geomset and/or Pointset elements can be removed from the display with
the aid of the REPRESENTATION command -- see next section).
The MODEL SETTINGS command can be used to specify the Component Design Data
attributes. For example,
gives the Design Data attributes DDRADIUS and DDHEIGHT values of 75mm and
200mm respectively. The DDRADIUS, DDHEIGHT and DDANGLE attributes are the
Design parameters used in the selection process for variable Components. In PARAGON it
is possible to use these attributes as part of the Component design. For example, whereas
an attribute such as PHEIGHT would normally be defined in terms of parameters, a
command such as
PHEI DDHEIGHT
(assuming a suitable current element) would set PHEIGHT to the Design height. (In such a
case, a MODEL SETTINGS command would need to be followed by a MODEL CE command
before any change in the display would be observed.)
To produce a display of a Component with insulation, the bore, temperature and working
pressure of the Component must be known. To this end the MODEL SETTINGS command
can be used to set the BORE, TEMP and PRESSURE. This must be done before the
Insulation Specification, INSPEC, can be specified. For example,
would set the temperature and bore Design Data attributes (the pressure would stay at its
default value, see below). The Insulation Spec may then be specified by a command such as
Assuming the drawing REPRESENTATION (see Section 6.4) is correctly set, the
Component will then be displayed with insulation shown.
NOTE: This command also deletes all default and specimen values of parameters. It
unsets the Insulation Specification.
The default values of the Design Data attributes, and the full syntax of how to set them, are
given in Section 6.4.
QUERY MODEL SETTINGS will output the Design settings currently in use. The Design
process is turned off by
MODEL END
6.2.1 P--points
P--points may be displayed in PARAGON in one of two ways. The form of display is
controlled by the REPRESENTATION PPOINTS command as illustrated in Figure 6--1.
REPRESENTATION PPOINTS ON
Position of
P-- point
REPRESENTATION PPOINTS OFF
The size of the arrow may also be controlled by the REPRESENTATION PPOINTS
command, as illustrated in Figure 6--2. The overall length of the arrow is specified in
millimetres. The default length is 50mm. Specifying a length of zero causes the P--point to
appear as a dot.
The P--point numbers may be omitted, or they may be displayed any size, the size being
specified in millimetres. The default size is 5 mm. The size of the numbers is controlled by
the REPRESENTATION PPOINTS command, as illustrated in Figure 6--3.
(not to scale)
Both LENGTH and NUMBERS may be set in the same command, for example:
NOTE: P--points are always displayed in some form. They cannot be omitted from the
display completely.
See the Reference Section at the end of this chapter for the full syntax of the
REPRESENTATION PPOINTS command.
6.2.2 P--lines
P--lines may be displayed in PARAGON in one of two ways. The form of display is controlled
by the REPRESENTATION PLINES command as illustrated in Figure 6--4.
REPRESENTATION PLINES ON
Position of
P-- line
REPRESENTATION PLINES OFF
The P--line identifier keys may be omitted or displayed. This is also controlled by the
REPRESENTATION PLINES command, as illustrated in Figure 6--5.
P--line length (default 50mm) and size (default 5mm) can also be controlled. See the
Reference Section at the end of this chapter for the full syntax of the REPRESENTATION
PLINES command.
Unlike P--points, P--lines can be omitted from the display completely. Whether a P--line is
drawn or not depends on the settings of three of its attributes:
LEVEL is a pair of integers. CLFLA and TUFLA are logical attributes which are set to
TRUE or FALSE (corresponding to ‘ON’ or ‘OFF’ respectively). When you first create a
P--line, CLFLA and TUFLA are both FALSE.
Control is initially on the setting of LEVEL. If the PARAGON LEVEL setting is within the
LEVEL range specified for the P--line (as its LEVEL attribute) then the P--line will be
considered for drawing, otherwise it will not be. If the level condition is satisfied, then
whether a P--line is displayed or not in PARAGON depends upon the settings of its CLFLA
and TUFLA attributes and upon the settings of the drawing options specified by the
REPRESENTATION command.
The drawing option settings interact with the drawing attributes of the P--lines thus: if an
‘ON’ REPRESENTATION setting matches a corresponding ‘TRUE’ attribute setting (e.g.
REPRESENTATION CL ON and CLFL TRUE) then the P--line will be drawn, otherwise it
will not be drawn.
The drawing of Geomset primitives is controlled in a similar way. The next section gives
examples of how the LEVEL, CLFLA and TUFLA attributes interact with the
REPRESENTATION settings.
Whether a Geomset primitive is displayed or not depends on the settings of its LEVEL,
CLFLA and TUFLA attributes (as for a P--line) and also on its OBST attribute. (The OBST
attribute is a number which defines the degree of obstruction for clash checking.)
If the PARAGON LEVEL setting is within the LEVEL range specified for the primitive (as
its LEVEL attribute), then the primitive will be considered for drawing, otherwise it will not
be. If the level condition is satisfied then, the primitive will be displayed if it has an OBST
value of 1 or 2 and the REPRESENTATION setting is
REPRESENTATION OBSTRUCTIONS ON
The primitive will be drawn in solid lines if OBST = 2 (hard obstruction), dashed lines if
OBST = 1 (soft obstruction0.
The control mechanisms of tube, centreline and obstruction are quite independent of each
other. So, for example, if a primitive has an OBST value of 2 and the REPRESENTATION
setting is OBSTRUCTIONS ON, the primitive will be drawn whatever the values of its
CLFLA and TUFLA attributes and the REPRESENTATION TUBE and CL settings
(provided that the PARAGON LEVEL setting is within the LEVEL range of the primitive).
The following example shows the Catalogue representation of a control valve, and how it
might appear in PARAGON with various combinations of TUBE, CL and OBST settings.
All the illustrations have PPOINTS ON.
SDSH 1
SCYL 4
SCON 1
LSNO 4
SCYL 2
SSPH 1
LSNO 3 LSNO 1
SCYL 3
LSNO 2
SCYL 1
For this example, the settings of the attributes of interest are considered to be:
SCYL 1, SCYL 2 and SDSH 1 are obstruction volume primitives, that is, they represent
the obstruction volume of the Component, not its physical geometry and dimensions. The
other primitives represent the actual geometry and dimensions of the Component.
The following illustrations show the appearance of the Component under various
REPRESENTATION settings.
Here the OBST ON setting matches the OBST 2 attribute value of the obstruction cylinders
and so they become visible, even though they have CLFL and TUFL both FALSE.
Here TUBE and CENTRELINE are both OFF but OBST is ON, and so only the obstruction
volume primitives are visible.
Compared with Figure 6--9, those primitives with TUFL TRUE now become visible because
TUBE is now ON. The obstruction primitives remain visible because OBST is still ON.
OBST is now OFF and so the obstruction cylinders disappear. (The obstruction dish
remains because it has TUFL TRUE.)
Here, all those primitives which have one or both of CLFL, TUFL TRUE are visible.
In Figure 6--13, all the REPRESENTATION settings are ON and so all the Geomset
primitives are visible.
Here, all the REPRESENTATION settings are OFF and so no primitives are visible. The
Component P--points are still visible since the REPRESENTATION PPOINTS setting in
the example is ON.
CL ON
TUBE OFF
OBSTRUCTIONS OFF
LEVEL 0
PPOINTS ON LENGTH 50 NUMBERS OFF
PLINES ON PKEYS OFF
which is regained by
REPRESENTATION DEFAULT
Note that the TVISIBLE and BVISIBLE end visibility flags have no effect in PARAGON.
This section gives the syntax of the MODEL SETTINGS command and the
REPRESENTATION command, as described in this chapter and in Chapter 4 (the latter for
setting component parameter defaults etc.).
The description of the syntax for the REPRESENTATION command is spread over a
number of separate sections, each showing how the command is applied to a particular type
of element. The final section summarises the complete REPRESENTATION syntax in a
single diagram.
Description: Sets default values for component parameters and specimen values for
other classes of parameters (see Chapter 4). Also sets design data
attributes; the numeric attributes may be used in place of parameters for
defining Pointsets and Geomsets.
MODEL SET IPAR 1 3.5 IPAR 2 4.5 Sets insulation parameter 1 to 3.5
and insulation parameter 2 to 4.5
MODEL SET APAR 3 5.1 OPAR 2 19.75 Sets attached parameter 3 to 5.1
and owning parameter 2 to 19.75
MODEL SET DES PAR 2 (ATAN(4 / 3)) Sets design parameter 2 to tan--1 4/3
The word CAT (short for CATALOGUE) in the fifth example is optional. You can use it when
setting default values for component parameters, and when setting specimen values for
structural parameters. You may find it helpful to use the word for clarity in macros, to
distinguish between Design DB parameters and other classes of parameters.
Values for any of these classes of parameters may be set in a single command, for example:
MODEL SET PAR 2 12 IPAR 1 17 APAR 2 32 DES PAR 3 25 DES OPAR 5 6.3
MODEL SET DDANG (ASIN(6 / 7)) Set Design Angle to arcsin (6/7)
Default values:
TEMP --100000
BORE 150.0 mm
PRESSURE 0.0
DDANGLE 90 degrees
DDHEIGHT 100.0 mm
DDRADIUS 225 mm
INSPEC Nulref (i.e. unset)
Command Syntax:
.---------------------<------------------.
/ |
>- MODEL - SETtings --+--*- CATalogue* -. |
| |- DESign -----| |
| |--------------+- PARam --. |
| | |- APARam -| |
| | ‘- OPARam -+ |
| | | |
| |- IPARam ----------------+------. |
| | .-------------’ |
| | ‘- number -+- value ----|
| | ‘- <expres> -|
| | |
| |-- INSpec --- name -----------------------|
| | |
| |-- TEMp --- value ------------------------|
| | |
| |-- BORe --- value ------------------------|
| | |
| |-- PREssure --- value -------------------|
| | |
| |-- DDHEIght --- value --------------------|
| | |
| |-- DDRADius --- value --------------------|
| | |
| ‘-- DDANGle ---+--- value ----------------|
| ‘--- <expres> --------------|
| |
‘--- DEFault --------------------------------+-->
Querying Syntax:
Examples:
Command Syntax:
.---------------------<-----------------.
/ |
>-- REPResentation --*-- CL -------------------------. |
| | |
|-- CENTreline -----------------| |
| | |
‘-- TUBE -----------------------+-- ON ---|
| |
‘-- OFF --+-->
Querying:
Q REPR TUBE
Q REPR CL
Examples:
.-----------------<--------------------.
/ |
>-- REPResentation --*-- PROFile --+-- CL ----------. |
| | |
|-- CENTreline --| |
| | |
‘----------------+-- ON ---|
| |
‘-- OFF --+-->
Querying:
Q REPR PROF
Description: This command enables individual drawing levels to be specified for the
display of catalogue elements. Every basic primitive shape has an
associated drawing level range attribute stored in the Catalogue. If the
specified drawing level coincides with this range, the 3D object will be
drawn when it is added to the Draw List.
The practical effect of this facility is that it allows you to minimise visible
detail when representing catalogue items. For instance, at level 3
steelwork may be represented as single line only, whereas at level 1 the full
detail may be visible. Level 3 may well be adequate for design purposes.
REPR LEVEL PIPE 5 Sets piping level to 5. All pipes which are added after
this command will be drawn at level 5. Those which
were already in the view will remain unchanged.
Command Syntax:
.-------------------<-------------------.
/ |
>-- REPResentation --*-- LEVel --+-- PIPE -------. |
| | |
|-- NOZZle -----| |
| | |
|-- STRUcture --| |
| | |
‘---------------+-- integer --+-->
Querying:
Examples:
REPR INSU ON
Command Syntax:
.--------------<------------.
/ |
>-- REPResentation --*-- OBSTruction --. |
| | |
|-- INSUlation ---+-----------|
| |
‘-- PROFile --+- OBSTruction -|
| |
‘- INSUlation --+- ON --.
| |
‘- OFF -+-->
Querying:
When p--points are on, they are drawn as small arrows with a cross at the
p--point position and with the arrow indicating the p--point direction. The
size of the arrow is controlled by the LENGTH option. P--point numbers
may also be displayed, as controlled by the NUMBERS option.
Examples:
Command Syntax:
Querying:
Q REPR PPOINTS
Description: P--line representation for structural Profiles may be set to ON or OFF. The
default setting is PLINES OFF.
When p--lines are on, the size of the arrow showing their direction is
controlled by the LENGTH option. P--line identifiers, in the form of the
settings of their PKEY attributes (TOS, BOS, NA, etc.) may also be
displayed, as controlled by the PKEY option.
Examples:
Command Syntax:
.---------------------<---------------.
/ |
>-- REPResentation --*-- PLINes -+- ON --. |
| | | |
| |- OFF -| |
| | | |
| ‘-------+- LENgth - <uval> -|
| | |
| ‘-------------------|
| |
‘-- PKEYs --+- ON --. |
| | |
‘- OFF -+-------------------+-->
Querying:
Q REPR PLINES
Q REPR PKEYS
.----------------------<-------------------.
/ |
>-- REPResentation --+--*-- TUBE - <onoff> --------------------------|
| | |
| |-- CL ----------. |
| | | |
| |-- CENTreline --+- <onoff> -----------------|
| | |
| |-- HOLEs - <onoff> -------------------------|
| | |
| |-- OBSTruction - <onoff> -------------------|
| | |
| |-- INSUlation - <onoff> --------------------|
| | |
| |-- LEVel -+- PIPE ------. |
| | | | |
| | |- NOZZle ----| |
| | | | |
| | |- STRUcture -| |
| | | | |
| | ‘-------------+- integer ---------|
| | |
| |-- PPoints - <onoff> - <ppsiz> -------------|
| | |
| |-- PROFile -+- CL ----------. |
| | | | |
| | |- CENTreline --| |
| | | | |
| | |- OBSTruction -| |
| | | | |
| | |- INSUlation --| |
| | | | |
| | ‘---------------+- <onoff> -----|
| | |
| |-- PNODes --. .--------<---------. |
| | |/ | |
| |-- SNODes --*- <onoff> ----------| |
| | | | |
| | |- COLour - <colno> -| |
| | | | |
| | ‘-- SIZe - <uval-----+----------|
| | |
| |-- POINts - <onoff> ------------------------|
| | |
| |-- PKEYs - <onoff> -------------------------|
| | |
| ‘-- PLINes - <onoff> -+- LENgth - <uval> -. |
| | | |
| ‘-------------------+--|
| |
‘-- DEFault ------------------------------------+-->
<ppsiz> is
<colno> is
D 3D Pointset (PTSET)
D Structural Pointset (PTSSET)
D 3D Geomset (GMSET)
D Negative 3D Geomset (NGMSET)
D Structural Geomset (GMSSET)
A PTSET is a collection of P--point elements. P--points are used in the design process to
position and orientate Piping Components, and to define their connectability to each other.
P--points may also be used in PARAGON to define the position and orientation of the 3D
Geomset primitives which make up Piping Components, Joints and Fittings. (Profiles do
not use P--points.)
A P--point has a 3D position and a direction, and is identified by a number. Each PTSET
includes a special P--point, P--point zero (P0), whose position is the component origin and
whose direction is the Z axis direction of the Component. It has no other attributes. P0 is
created automatically by PARAGON; you cannot change it in any way.
The numbering of the P--points of Piping Components must follow certain conventions -- see
Appendix A for a summary of these, and the ISODRAFT Reference Manual for fuller details.
There are no special conventions for numbering the P--points of Joints and Fittings.
A P--point has a connection type attribute, which is used only when the P--point belongs
to a Piping Component. The connection type attribute can be used to specify how a Piping
Component is connected to another at the position of the P--point, for example by a butt weld
or socket weld.
A P--point has a bore attribute, which is used only when the P--point belongs to a Piping
Component. It can be used to specify the bore of the pipe at that point.
PDMS’s data consistency checks (see the VANTAGE PDMS DESIGN Reference Manual)
can be used to check that the connection type attributes of Piping Components are
compatible with the corresponding attributes of the Components to which they are
connected. The compatibility of connection types is defined in a Connection Compatibility
Table (CCTAB) -- see Section 9.3 for details.
Use of the REPRESENTATION command affects how P--points are drawn by PARAGON;
see Section 6.2 for details.
A PTSET may contain one or more of the three types of P--point element:
A PTAXI allows a P--point to be defined in terms of an axis and a distance along that axis.
A PTAXI has no member elements and has the following attributes:
NUMB must be set as a value. PAXI must be set as a direction -- see Section 8.5.2 for details.
The other attributes may be set as values or words (as appropriate), or in terms of
parameters (which in turn are values or words). The classes of parameter which may be
used depend on the class of Component (Piping Component, Joint or Fitting) which uses the
P--point -- see Section 4.7 for details. PCON and PBOR are used for Piping Components only.
They have no meaning if the P--point is used by a Joint or Fitting. For details of PSKEY
settings, see Section 8.5.8.
These conventions also apply to the attributes of the PTCAR and PTMIX elements
described below. See Section 8.5 for examples of setting these attributes.
A PTCAR allows a P--point to be defined by specifying its position and direction explicitly. A
PTCAR has no member elements and has the following attributes:
A PTMIX allows a P--point to be defined by specifying the position explicitly but using PAXI
to specify the direction. A PTMIX has no member elements and has the following attributes:
A PTSSET is a collection of P--line elements (PLINE). P--lines are used in the Catalogue by
Profiles and Joints. P--lines are used in the design process to position and orientate Sections
(derived from Profiles) and Joints.
A P--line is the structural counterpart of a P--point. It is a line which runs the full length of a
Component parallel to its Z axis. Viewed in the XY plane, it appears as a point. This point is
its position. A P--line also has a direction. This is not the direction of the line itself (which
is always parallel to the Z axis of the Component), but a direction from the line in the XY
plane. The position and direction are defined in XY coordinates only. Figure 7--1 shows a
two--dimensional view and a three--dimensional view of a P--line on the top of a Section.
Direction Position
of P-- line of P-- line
PROFILE X
(viewing in
- Z direction)
Position
Direction
of P-- line of P-- line
X
SECTION Z
P--lines may be used in PARAGON to define the position and orientation of the 2D
primitives in a Structural Geomset which make up a Profile. They cannot be used to
position and orientate the 3D primitives which make up a Joint.
One of the P--lines in a Structural Pointset must be designated as the neutral axis p--line.
This is used in DESIGN for positioning and orientating the Component. (The neutral axis is
the line where there is no stress in bending, and about which the Component bends.) A
P--line is designated as the neutral axis by setting the neutral axis reference attribute
(NAREF) of the Structural Pointset to the name of the P--line.
PKEY is a word attribute which identifies the P--line. It is equivalent to the NUMB
attribute of a P--point. PLAXI is a direction, equivalent to the PAXI attribute of a P--point.
PKEY must be set as a word. PLAXI must be set as a direction -- see Section 8.6.3 for details.
PX and PY may be set as values or in terms of parameters. The classes of parameter which
may be used depend on whether the P--line is used by a Profile or by a Joint -- see Section 4.7
for details. Chapter 8 gives examples of setting these attributes.
The settings of LEVEL, CLFLA and TUFLA and the use of the REPRESENTATION
command affect whether or not the P--line is drawn by PARAGON. LEVEL is a pair of
numbers specifying a range and CLFLA and TUFLA are set to TRUE or FALSE
(corresponding to ‘on’ or ‘off ’ respectively). The way in which LEVEL, TUFLA and CLFLA
and the REPRESENTATION settings interact is discussed in Section 6.2. (The settings of
LEVEL, CLFLA and TUFLA also affect whether or not the P--line is drawn in DESIGN.)
The primitives in the Geomsets also have LEVEL, CLFLA and TUFLA attributes which
affect whether or not they are drawn in PARAGON and DESIGN.
NOTE: A P--line has its own set of axes which are used in the design process (not in
PARAGON). See the DESIGN Reference Manual for details.
GMSET has no attributes other than the standard ones. Each member element of a 3D
Geomset has the following attributes in addition to the standard ones:
The settings of LEVEL, CLFLA and TUFLA affect whether the primitive is drawn or not by
PARAGON (or DESIGN), as they do for P--lines. See Section 7.2 for details.
OBST is a number which defines the obstruction level of the primitive for use by DESIGN’s
clash checking facility:
D OBST = 0: No obstruction. The primitive will not clash with anything (used for
symbols and negative volumes).
D OBST = 1: ‘Soft’ obstruction. Used for insulation, access volumes, penalty volumes,
etc.
D OBST = 2: ‘Hard’ obstruction. DESIGN’s clash checking facility will report hard
interference with any item having OBST 1 or 2.
The LEVEL, OBST, CLFLA and TUFLA attributes are common to all primitives. Each
primitive also has additional attributes depending on its shape; these are described in the
next section.
The following primitive elements are used by 3D Geomsets. They all have the standard
attributes and the common attributes LEVEL, CLFLA, TUFLA and OBST.
Components whose GTYPE attribute is TUBE can use BOXI elements to give, for example,
implied tube of rectangular cross--section. BOXI elements can be used for modelling
ducting, trunking and cable trays.
When implied tube is drawn using BOXI elements, the Y axis of the implied BOXI is set to
the PLeave direction of the preceding component. The X axis of the BOXI is set to be
mutually orthogonal to the PLeave and the Z axis of the preceding component (which
usually corresponds to the X axis of the component). The Z axis of the BOXI is then derived
from its X and Y axes (and usually corresponds to the Z axis of the component).
A 3D Geomset may contain more than one BOXI element and corresponding P--points may
be offset in the X or Z directions.
Note for Pipework Designers: If there is no preceding component (that is, if the implied
BOXI forms the Head of a Branch), the Y axis will be set to the Parrive of the following
component (that is, the first component in the Branch). If there are no components, the
BOXI will be set to the orientation of the Zone. (Since Pipe and Branch elements have no
coordinate system, this is the lowest level in the design hierarchy from which an orientation
can be derived.)
There are three types of cylinder primitive defined in different ways. LCYL is defined by the
distances from the origin to the two end faces. LCYL has particular attributes as follows:
This type of cylinder primitive is defined by the distance to the bottom face from the origin
and the height. SCYL has particular attributes as follows:
This is similar to the SLCY available in the Design Data and has its main use in the
modelling of mitred bends. SSLC has the following particular attributes:
Y
PYTS (+n)
PAXI
PHEI
PYBS (-- n)
PDIS PDIA
X
ORIG PDIA
PAXI
PDIS PHEI
The Disc primitive is a circular element of zero thickness. SDIS has particular attributes as
follows:
This is similar to the DISH available in the Design Data. It allows symbolic modelling of
control valves and closer modelling of other Components. SDSH has the following
particular attributes:
If PRAD=0 a spherical section dish is drawn, if PRAD>0 an ellipsoidal section dish is drawn.
D PTS -- a set of numbers (up to six) representing P--point numbers of the P--points in
the corresponding Pointset, which determine the course of the line.
The values held in PTS are set by the SETPoints command, followed by point specifications
in which each p-point identifier is preceded by ‘P’ or ‘T’, e.g. P1 P2 T3 P4. When the P--point
is preceded by P it is treated in the same way as a point element (POINT) in the Design
Data; when preceded by a T it is treated in the same way as a tangent point element (TANP)
in the Design Data. (See DESIGN Reference Manual for further details).
The main use of this element is in the creation of rectangular reducers for ducting etc. LPYR
has the particular attributes as follows:
The circular torus is only part of a torus; it is not permitted to subtend more than 180
degrees. It is circular in cross--section. SCTO has particular attributes as follows:
D PAAX, PBAX -- direction of axes normal to the end faces of the torus
D PDIA -- diameter of the cross--section of the torus.
D TVISI -- visibility of top face
D BVISI -- visibility of bottom face
The rectangular torus is similar to the circular torus except that it is rectangular in
cross--section. SRTO has particular attributes as follows:
D PAAX, PBAX -- direction of axes normal to the end faces of the torus
D PDIA -- width of the cross--section of the torus
D PHEI -- height of the cross--section of the torus
D TVISI -- visibility of top face
D BVISI -- visibility of bottom face
The Snout primitive is a cylindrical element of varying diameter along its length. It may be
eccentric or concentric. LSNO has particular attributes as follows:
PAAXI
The sizes of the top and bottom surfaces of the snout may be defined in terms of their radii
instead of their diameters.
Components whose GTYPE attribute is TUBE can use TUBE Geomset elements to give, for
example, implied tube of circular cross--section. TUBE has particular attributes as follows:
In addition to the attributes defining its position, each SVER can have a radius which
applies a convex or concave fillet to the loop at that point.
PBAX of SEXT
(PX,PY)
of SVER
PAAX of SEXT
In addition to the attributes defining its position, each SVER can have a radius which
applies a convex or concave fillet to the loop at that point.
Y (PBAX)
SLOO = SVER
Origin
(PX,PY,PZ)
PANGLE
Z
X (PAAX)
The Negative Geomset defines the symbol that is drawn for a particular Component by
PARAGON (and DESIGN) and also defines the obstruction geometry of the Component for
use when checking for clashes.
Negative Primitives have the same attributes as the corresponding positive primitives,
with the addition of the NAPP (Negative APPlies to) attribute, which controls whether the
negative primitive is removed from the item itself, or the attached or owning item. The
allowed values are:
The positive values can be combined so that the hole will be created in more than one item.
For example, NAPP=6 means that the volume will be removed from the item itself and the
item’s owner.
The following table shows what Attached and Owner mean for items that can referenced
NGMSEs.
For example, if a SUBJoint references a NGMSE which contains an NSBOX with NAPP=1,
the NSBOX will be removed from the Subjoint’s attached Section.
D SREC -- rectangle
D SANN -- annulus
D SPRO -- user--defined profile
Like the member elements of a 3D Geomset, each member element of a Structural Geomset
has LEVEL, CLFLA, TUFLA and OBST attributes.
NOTE: For correct clash detection, the maximum number of primitives with OBST set to 1
or 2 in any GMSSET is 20; the order of these in the members list is not important.
See the VANTAGE PDMS DESIGN Reference Manual for details of the best way of
setting up Component data so as to minimise processing time for clash detection.
The following primitive elements are used by Structural Geomsets. They all have the
standard attributes and the common attributes LEVEL, CLFLA, TUFLA and OBST. The
additional particular attributes of each element are as described below.
Note that each 2D primitive has effectively two types of positional attributes which allow its
geometry to be changed progressively as it is extruded in space to create a 3D design
element (such as a structural SCTN or GENSEC element). The P... attributes define the
geometry at the Start of an extruded section, while the D... attributes define the change in
that geometry between the Start and End of the extruded section.
PXLEN
PLAXIS
PYLEN
PY
X
PX
NOTE: PANG must be in the range --180_ to +180_. Positive angles are anticlockwise
when the primitive is viewed in the --Z direction.
PANGLE
PRADIUS
PLAXIS
PWIDTH
PY
PX X
In addition to the attributes defining its position, each SPVE can have a radius which
applies a convex or concave fillet to the profile at that point.
D PLAXI -- direction of Y axis of profile (this defines coordinate system for SPVEs)
Y
SPVE (PRAD set to positive value)
X
PX
This chapter describes how to create and manipulate the member elements of the PDMS
Catalogue database.
Querying:
OLD
END
SAME
CE
OWNER
GOTO e.g. GOTO PTREF
NAME
UNNAME
LOCK
UNLOCK
These commands are those which are common to all ‘constructor’ modules of PDMS and
some are used in this chapter without further explanation. However, the element types
which the above commands operate on relate to the Catalogue database rather than the
Design database (so, for example, NEXT SITE is meaningless in PARAGON).
Catalogues and Sections are created using the NEW command. You would normally also
specify names by which you can recognise and refer to the elements created. For example:
will create a Catalogue with the name /ANSI--CATALOGUE in the Catalogue database.
will create a Piping Section with the name /FLANGES and a Structural Section with the
name /PROFILES. Similarly,
will create a Piping Category and a Structural Category with the names given.
NEW SCOM
will create a Piping Component with unspecified component parameters, the values of
which may be set later.
If the Component is to be named, this can be done at the same time; for example,
The attributes of the Component (see Section 4.8) are set simply by following the attribute
with the word, name or value(s) to be assigned to it. For example:
NEW SCOM
GTYPE ELBO
PTREF /PSE1
GMREF /GSE1
PARAM 20 19.1 12.7 37.1 BWD
The above commands create a Piping Component, of generic type ELBO, which is defined by
3D Pointset /PSE1 and 3D Geomset /GSE1, and which has the five component parameters
shown. The Pointset and Geomset which are referred to by name must already exist; they
would have been created by the commands
All five component parameters have been given values using a single command line, but
they can be given values individually by using commands such as
PARAM[1] 20
PARAM{2] 19
...
etc.
NOTE: You can only use the PARAM[number] syntax to change the value of a parameter
which has already been set.
This facility allows component parameter definitions to be ‘edited’. (Caution: If you delete a
COMP which is referred to by a SPCO -- via the CATREF attribute of a design component --
this reference will be lost.). The use of component parameters and the other classes of
parameter is discussed and illustrated in the next section.
NOTE: If you give a PARAM command with, say, four values as a single command line,
PARAGON sets the values of the first four component parameters and deletes all
the rest.
You may define default values which PARAGON will use if you are working with a
Component whose component parameters have not been set up. See Section 4.7 for details.
QUERY ATTRIBUTES
QUERY PARAMETERS
QUERY PARAMETER[1]
QUERY PARAMETER[2]
etc.
8.3.1 Introduction
Piping Components, Profiles and Fittings each use one type of Pointset and one type of
Geomset. Joints use both types of Pointset and one type of Geomset. The attributes of
Pointsets and Geomsets may be defined in terms of parameters, set either explicitly or as
real expressions (which may themselves incorporate the current settings of other
parameters). (The classes of parameter which may be used depend on the class of
Component -- see Section 4.7 for details.)
PBORE (PARAM[1])
This means that the value assigned to the bore of the P--point is the value of the first
component parameter.
The Y dimension of a box in a 3D Geomset used by a Joint could be defined as the expression
PYLEN (APARAM[2] + 3)
This means that the Y dimension of the box is to be given a value in the design process,
taken from the Section to which the Joint is attached. The value of the Y dimension of the
box is the value of the second component parameter of the attached Profile plus 3 mm.
The use of parameters makes it possible to use the same Pointsets and Geomsets for large
numbers of catalogue items. For example, there may be families of tees, valves, I--beam
profiles etc., each family containing items which are geometrically similar. In this way, the
Catalogue size and the effort needed to prepare input data are minimised.
Examples of the parameterisation of typical Components are given later in this chapter.
The values assigned to parameters, the uses to which they are put, and the number of
parameters used, are arbitrary, depending only on the skill and experience of the user,
except in the special case of a Piping Component which represents implied tubing (GTYPE
attribute set to TUBE) and which has no Geomset. In this case, component parameter 2
must be the outside diameter. If the tube is to be insulated, insulation parameter 1 must be
twice the thickness of the insulation.
Note on the use of Insulation Parameters: Insulation parameters may be used in two
ways. They may be used in an additive manner to increase the diameter or length of a
primitive or, if there is a significant change in the geometry from the uninsulated to the
insulated form, they may be used to define a new primitive. Where there is no insulation,
the insulation parameters will be zero, yielding a primitive of zero diameter (but probably
non--zero length).
Any expression which includes parameters and which evaluates to a real result may be
built into definitions of Pointsets and Geomsets. For example:
(For the full range of expression syntax available, see the Plant Design Software
Customisation Guide.)
(1) PBORE
(5)
(3) THICKNESS
D PARAM 1 -- PBORE
D PARAM 2 -- Outside Diameter
D PARAM 3 -- Thickness
D PARAM 4 -- Connection Type at P1
D PARAM 5 -- Connection Type at P2
(9)
(6)
(5)
(3)
(8) (4)
(11)
(12)
(10) (1)
(2)
(7) (n) = component parameter number
(3)
(4)
(1)
(2)
(1)
(3)
(A1)
(A2)
(2)
An Angle Joint might be parameterised using three component parameters and two
attached parameters, as shown in Figure 8--4.
PTAXI
If the Pointset is used by a Piping Component, you may optionally define the attributes:
PCON and PBOR are meaningless if the Pointset is used by a Joint or Fitting.
PAXI Z
PAXI Y
DDA
PAXI Y DDA X
PTCAR
If the Pointset is used by a Piping Component, you may optionally define the attributes:
PCON and PBOR are meaningless if the Pointset is used by a Joint or Fitting.
PTCDIR Y45Z
PTCDIR - Y75Z5X
PTMIX
If the Pointset is used by a Piping Component, you may optionally define the attributes:
PCON and PBOR are meaningless if the Pointset is used by a Joint or Fitting.
PAXI Y DDA X
PAXI - Y
A suitable 3D Pointset for the reducing tee shown in Figure 8--2 would be created as follows:
Notice how all the P--point attributes may be defined on one line. The last P--point (P3) could
alternatively be defined as a Cartesian P--point:
NEW PTCAR
NUM 3 PCON (PARA[8]) PBOR (PARA[3])
PX (PARA[6]) PY 0 PZ 0
PTCDIR X
The classes of parameter which you can use depend on the class of the Component
which uses the P--point -- see Section 4.7 for details.
PAXI Z 70 - X
PAXI X DDA Y
DDA
PAXI - Y 70 - Z
PDIS 100 sets P--point position to 100 units along defined axis
PDIS (PARAM[1]) sets P--point position to (value of first component
parameter) units along defined axis
For the reducing tee shown in Figure 8--2, the position of P--point 3 could be defined by the
commands:
PAXI X
PDIS (PARAM[2])
Position in a PTCAR element and a PTMIX element is defined by the PX, PY and PZ
keywords, each followed by a value or a parameter function. For example:
For other examples, see Figure 8--6. Note that any one, any two, or all three of X, Y, Z may be
present in the PTCDIR command line, in any order. The rotation value may be positive,
negative or absent altogether (i.e. zero). If you do not define the direction, DIR Y is assumed.
These three attributes are common to all three types of P--point elements, and are set by the
PBORE, PCONNECTION and NUMBER (minimum abbreviations PBOR, PCON, NUM)
commands respectively. PBOR and PCON may be set as parameter functions as well as as
words. Examples:
If you do not define the bore or the P--point number, a value of zero is assumed.
By default, each SKEY has associated with it a standard end condition (showing the pipe
connection type) which applies to each of the component’s connection points. The end
condition for any individual connection point may be modified, if required, by setting the
PSKEY attribute of the corresponding P--point to a PDMS word chosen from the following:
BW Butt Weld
CP Compression
FL Flange
SC Screwed
SW Socket Weld
PL Plain
The effect of setting PSKEY to one of these words for a P--point of type PTAXI, PTCAR or
PTMIX is that ISODRAFT will then add the symbolic representation of the specified end
condition to the symbol derived from the corresponding SKEY when it plots an isometric
drawing showing the component. The default setting for PSKEY is always NULL, which
means that ISODRAFT plots only the standard end conditions for the symbol.
Note that the effect is additive, so that ISODRAFT superimposes any user--specified end
condition (derived from a non--Null PSKEY setting) on top of any end condition which forms
part of the standard symbol associated with the SKEY. The use of the PSKEY facility is,
therefore, applicable mainly to components which do not have other end conditions already
defined, particularly those associated with user--defined symbols (as detailed in the
ISODRAFT Reference Manual).
A suitable Structural Pointset for the Profile shown in Figure 8--3 would be created as
follows:
Notice how all the P--line attributes may be defined on one line. Reference information
concerning the setting up of the P--line attributes is given in Sections 8.6.3 to 8.6.6.
The neutral axis reference identifies a P--line in the Structural Pointset. It is set by the
NAREF command. The attribute is usually set to the name of the P--line, but may be set to
the P--line’s number in the member list of the Pointset. For example:
If you do not set NAREF, DESIGN will make an assumption about where the neutral axis is.
You are strongly recommended to set the neutral axis reference in the Catalogue.
DESIGN will use as the neutral axis the first P--line in the Structural Pointset which has a
PKEY value of NA, if any. Failing that, it will choose the first P--line with a PKEY value of
NAXI, and failing that, it will choose the first P--line with a PKEY value of ZAXI. If there are
no P--lines with a PKEY value of NA or NAXI or ZAXI, DESIGN will assume that the
neutral axis of the Component lies at the component origin and has a direction along the
positive Y axis.
The classes of parameter which you can use depend on the class of the Component which uses the P
point -- see Section 4.7 for details.
PLAXI Y DDA - X
DDA PLAXI X 45 Y
PLAXI X PARA1 - Y
PLAXI - Y
Position in a P--line element is defined by the PX and PY keywords, each followed by a value
or a parameter function. For example:
A P--line is identified by its key in the same way as a P--point is identified by its number. The
key is defined by the PKEY keyword followed by a word. For example:
PKEY may be set to any desired word value. Typical values are:
Whether a P--line is drawn or not depends on the settings of its LEVEL, TUFLA and CLFLA
attributes, and the REPRESENTATION settings. How a P--line is drawn also depends on
the REPRESENTATION settings. SeeSection 6.2 for details.
Creating a Geomset consists of creating the relevant member primitives and setting the
attributes for each primitive. For each primitive the OBST attribute must be set, whilst for
a primitive that is required to be drawn the LEVEL, TUFLA and CLFLA attributes must
also be set. (See Chapter 6 and the DESIGN Reference Manual for details of these
attributes.) 3D Geomset elements and their attributes are listed in Section 7.4.
NOTE: Only the first 20 primitives in a Geomset with OBST values of 1 or 2 are considered
by DESIGN’s clash checking facility.
By using the TUFLA and CLFLA flags, you can create two different drawings of a
Component, a double--line representation (tube) and a single--line ‘stick’ representation
(centreline).
To define the tube representation for the tee shown in Figure 8--2 (with clash geometry) the
commands shown below could be used. (The P--points in the following examples relate to the
Pointset defined in section 8.5.1.)
To define the centreline representation for the tee (with welded joints), the following
commands could be used. Figure 8--10 shows the symbol produced. The illustration is
drawn with REPRESENTATION PPOINTS ON LENGTH 0 NUMBERS ON. The P--points
are thus displayed as dots, but they cannot be seen because they lie on the displayed LINEs.
NEW LINE P1 P2
OBST 0 CLFL TRUE DIAM 1
Note how a P--point has been used to define an axis direction and origin for a primitive -- see
the Reference Section at the end of this chapter for details.
To put the flanges on the tee the first two representations (as given above) would remain the
same but the centreline representation would not need the SSPH elements (which
represent the welds). The latter are replaced by using the following commands to represent
the flanged connections:
NEW SCYL PAXI P1 PHEI (-PARA[10]) PDIA (PARA[9])
PDIS 0 OBST 2 CLFL TRUE TUFL TRUE
NEW SCYL COPY PREV PAXI P2
NEW LCYL PAXI P3 PTDI 0 PBDI (-PAR[12]) PDIA (PAR[11])
OBST 2 CLFL TRUE TUFL TRUE
each primitive. It also defines the symbol that is drawn for a particular Component and the
obstruction geometry of the Component. The Profile is built up from a combination of
Structural Rectangles (SREC) and Structural Annuli (SANN), as described in Section 7.6.
Structural Geomset elements and their attributes are listed in Section 7.7.
To define the tube representation for the Profile shown in Figure 8--3, the commands shown
below could be used. A simplified clash geometry for the Profile is specified by defining a
bounding box for the Profile with ‘hard’ obstruction and giving the primitives of the Profile
itself ’no obstruction’. The P--lines used are those defined in Section 8.6.1.
A P--line may be used to define an axis direction and position for a primitive. The example
below shows how the upper flange could be positioned and orientated using a P--line. See
the Reference Section at the end of this chapter for details.
The following attributes of P--points, P--lines and Geomset primitives may be set equal to
parameters or functions of parameters (as well as to constant values):
Axial attributes of both 3D and 2D primitives define a position and a direction. An axial
attribute of a 3D primitive may be specified as a direction in one, two or three dimensions or
as a P--point. Similarly, the axial attribute of a 2D primitive may be specified as a direction
in one or two dimensions or as a P--line.
Examples:
PAAX -P2 sets PAAX to be opposite the direction of P--point 2 with its origin
at the position of the P--point
PBAX X34-Y sets PBAX to the given direction from the component origin
PCAX X45Y30Z sets PCAX to the given direction from the component origin
PAXI X DDANG Z takes the Design DDANGLE and calculates the direction
accordingly
Syntax:
where <axis> is
>--+-- X --.
| |
|-- Y --|
| |
‘-- Z --+-->
If the axial attribute of a 2D primitive is specified as a P--line, the direction of the axis is
taken to be the direction of the P--line, and the origin of the axis to be the position of the
P--line. If the axial attribute is specified as a direction or direction expression, the origin of
the axis is taken to be the component origin.
Examples:
PLAX PLIN NAXI sets PLAX to be the direction of the P--line whose PKEY
attribute is NAXI; the origin of the axis is at the position of
the P--line
PLAX X60-Y sets PLAX to the given direction from the component origin
Syntax:
where <axis> is
>--+-- X --.
| |
‘-- Y --+-->
Detailing Text (SDTE) elements contain descriptive text relating to a Component, which is
used during the construction of drawings, reports, take--off sheets etc. An SDTE element
exists at the same level in the Catalogue database hierarchy as a Component element (i.e. it
is a member of a Section or Category) and is referred to from SPCOM elements in the
Specification.
An SDTE element (which will usually be named) is created simply by typin, for example:
NEW SDTE /C/T1
The text itself exists as an attribute of the SDTE element; namely one of the attributes
RTEX, STEX or TTEX. The text is input simply by typing the attribute name followed by
the text itself in quotes; for example:
STEX ’21DD-JJOOA2 12.31’
The choice of attribute name depends on the PDMS module which is to use the related text.
STEX and TTEX are used primarily by the detailing interface modules, and the attribute to
be used will be specified from that module. The format of the text depends on the detailing
module in use -- see the appropriate Reference Guide for details.
RTEX is used by ISODRAFT, which also uses another SDTE attribute, SKEY. SKEY is a
four--character code which represents a geometric description of the associated Component
type. RTEX and SKEY must be set in order for ISODRAFT to work correctly. A typical pair
of commands would be:
RTEX ’COUPLING - SOCKET WELD 3000LB’
SKEY ’COSW’
(The SKEY codes are fixed for a given element type -- see the ISODRAFT Reference Guide
for a list.)
Material Text (SMTE) elements contain descriptive text describing the material(s) from
which the physical component is constructed, and is used during the construction of
drawings, reports, take--off sheets etc. An SMTE element exists at the same level in the
Catalogue database hierarchy as a Component element (i.e. it is a member of a Section or
Category) and is referred to from SPCOM elements in the Specification.
An SMTE element (which will usually be named) is created simply by typing, for example:
The text itself exists as an attribute of the SMTE element; namely one of the attributes
XTEX, YTEX or ZTEX. The text is input simply by typing the attribute name followed by
the text itself in quotes, for example:
The choice of attribute name depends on the PDMS module which is to use the related text,
the attribute to be used being specified from that module. XTEX is used by ISODRAFT.
The Connection Compatibility Table (element name CCTA) holds a list of all the compatible
connection types for Piping Components in a set project. A CCTA is an administrative
element which exists at the same level as CATA in the hierarchy. A CCTA has Connection
Compatibility (COCO) elements as its members, each of which has a pair of coded
connection types stored as its CTYPE attribute. These connection types are those referred
to in the PCON attribute of a Piping Component’s P--points.
The commands below give an example of the setting up of a typical connection table.
NEW CCTA
NEW COCO /WELDWELD CTYPE WELD WELD (weld to weld)
NEW COCO /SCRDSCRD CTYPE SCRD SCRD (screwed to screwed)
NEW COCO /WELDBW CTYPE WELD BW (weld to butt weld)
Note that ISODRAFT uses the connection codes to derive bolting requirements, and so the
connection codes used must conform to certain standards -- see Appendix B and the
ISODRAFT Reference Guide for details. Setting up the Connection Compatibility Table
should be one of the first tasks to be carried out when commencing a design project using
PDMS.
The Bolt Table hierarchy contains information describing the nature of the bolted
connections of Piping Components in a project. Although the Bolt Table is part of the
Catalogue database, and so must be set up using PARAGON, it has been designed for the
exclusive use of ISODRAFT and so is described in detail in the ISODRAFT Reference Guide;
only a summary is presented here. Element creation and attribute setting is done in the
usual way.
WORLD
SECT
D BTSE -- the Bolt Set is the administrative element for caltalogue component bolting
information. It owns Bolt P--point (BLTP) elements.
D BLTP -- the Bolt P--point stores the bolting information for an individual bolt for a
particuar type of flange. It has the following attributes:
D BLIS -- the Bolt List is an administrative element which groups together Standard
Bolt (SBOL) elements.
D DTAB -- the Diameter Table stores information on standard bolt lengths, held as a
string of values in its BLEN attribute. DTAB is accessed from the NSTD attribute of the
SBOL element.
PARAGON enables unit types to be set up which will then be linked to relevant attributes of
the various elements which appear throughout the PDMS databases. The most common
units (the default units) are millimetres, inches or feet and inches, which are usually
assigned to bore and distance attributes. These units currently apply to all PDMS modules
except PROPCON.
You may also define other units with conversion factors to relate one set of units to another;
unit definitions can be collected together into sets to be used for different purposes.
Information controlling units is held in a UNIT element of the Catalogue Database. The
UNITS hierarchy is shown below:
WORLD
MSET USEC
MTYP UDEF
ATLI
D UNIT -- The UNIT element is the top--level element of the hierarchy. It has three
special attributes: BUNI, DUNI and DFUN. BUNI and DUNI can be set to determine
the default Bore and Distance units, respectively. They are set to any of MM, INCH,
MIL or FINC (for feet and inches). A typical sequence of setup commands would be:
NEW UNIT
BUNI INCH
DUNI FINC
This would mean that, by default, all bore values are interpreted as inches and all distance
values, e.g. HEIGHT, DISTANCE, as feet and inches. If user--defined units are to be used,
then an MSET element should be named in the DFUN attribute of the UNIT, indicating
that that MSET element should be used as the default measurement set. Each PDMS
module has its default units initialised at run time to those defined in the first UNIT
element of the first Catalogue DB in the MDB being used. BUNI and DUNI may also be set
to NULL.
D MTYP -- Measurement Type. This element forms the link between a collection of
attributes and the Units Definition (UDEF) to be used for them. The attributes are
accessed via the ATLI (Attribute List) elements owned by the MTYP and the Units
Definition via its UREF attribute. The latter simply contains the name of the UDEF
element which is to be used for the attributes named in the member ATLI elements.
D ATLI -- Attribute List. Each ATLI element contains (as its ATNA attribute) the name
of the attribute for which the UREF (see above) applies.
D USEC -- Unit Section. This is an administrative element used to collect together UDEF
elements.
D UDEF -- Units Definition. One UDEF is required for each non--PDMS unit that you
wish to implement. UDEF has the following special attributes:
S ABREV -- Abbreviation. This is the abbreviation used when outputting a value under the
control of this UDEF, or when inputting a value which is in a UNIT that is not the one for that
attribute in the current MSET. The attribute is an eight--character text.
S MULT -- Multiplier. This is a conversion factor which is used in conjunction with ADEN, to
convert from input/output units to PDMS stored units. This is done on the basis that:
Output value = (Stored value -- ADEN) / MULT
Stored value = (Input value * MULT) + ADEN
The exponential facility is useful in the accurate setting of MULT and ADEN. For
example:
MULT 0.12345 EX -8
will set MULT to 0.0000000012345
S SIGF and DECP -- Significant Figures and Decimal Places. These relate to the output of units.
In certain PDMS modules, e.g. PROPCON, the choice of units to be used can be indicated by
using the command:
UNITS name
where name is the name of an MSET. If this is not done, the units will be those given by the
DFUN attribute of the UNIT element, as explained above.
Following this, whenever the value of a special attribute is set or queried, its name (e.g.
TEMP for temperature) will be compared with the ATNA attributes of all ATLIs under the
current MSET. If a match is found, then the UREF of the MTYP owning the matching ATLI
will be used to access the relevant UDEF.
When output, such values are followed by their abbreviations to remind you which units are
being used.
If you wish to input a value which is in a UDEF that is not referred to from the current
MSET, then you may use the abbreviation of that value as a key. For instance, in
PROPCON, if the current temperature unit is centigrade, but there is a UDEF defining
Fahrenheit (with abbreviation ‘deg. F’), it would appear as
TEMP 35 ’deg. F’
UREF /INCH set the Reference Units that the MTYP refers to
NEW ATLI create an Attribute List for the MTYP
ATNA ACBO set the Attribute Name that is required to be output/input
in inches
UNIT
MSET USEC
ATNA ACBO
If ACBO is referred to in PROPCON, the attribute name (ATNA) is searched for in the UNIT
hierarchy. The search then moves up the hierarchy to find the MTYP attribute UREF. The
MULT attribute of the UDEF (found from the UREF) is then applied to the stored ACBO
attribute and the ABREV is output with the resulting value.
As a further example, to define and use a unit system called /IMPERIAL, for which
temperatures (TEMP, PTEM and RTEM) will be in Fahrenheit and pressures (PRES,
RPRE and IPRE) will be in PSI, the instruction sequence would be:
NOTE: It is possible to set up UNIT elements with MSETs containing duplicated ATNAs.
This is not prevented, but a warning is given on attempting to use such an MSET.
Note that the STEX attribute of a TEXT element is completely independent of the STEX
attributes of the Detailing Text (SDTE) elements described in Section 9.1. The TEXT
element can occupy many positions in the hierarchy -- it can be owned by UNIT, CATA,
SECT, CATE, STSE, STCA, CCTA, SPEC, BLTA, BLIS, LTAB or MBLI elements.
A Dataset (DTSE) is a collection of DATA elements. These can be used to store any items of
catalogue data which need to be queried directly from within the DESIGN or DRAFT
modules and which are not accessible by other means.
Consider the following examples, which allow you to query two properties of this
parameterised I--beam in DESIGN:
P3
P4 P1
P2
Datakey: DEPT
Dtitle: ’Depth of beam’
Pproperty: (PARAM [1] )
Dproperty: 600
Purpose: DATA
Number: 1
The command Q PROP DEPT in DESIGN or DRAFT will return the depth of the current
beam (or the default of 600 if the true value cannot be evaluated).
Example 2: The cross--sectional area of the beam
Datakey: XSEC
Dtitle: ’Cross-section of beam’
Pproperty: (((P [1] -- (2 * P[3])) * P[4]) + (2 * (P[2] * P[3]))
NOTE: PARAM has been shortened to P here to show the format of the
expression more clearly. The full version must be used when setting the
attribute.
Purpose: DATA
Number: not relevant here, so leave unset
The command Q PROP XSEC in DESIGN or DRAFT will return the calculated
cross--sectional area of the current beam.
Similarly, you could query the following attributes of this DATA element:
PBORE ( PARAM[1] + 20 )
If the dataset associated with the component contains a DATA element with the Datakey
DBOR, and DBOR has its PPRO attribute set to the expression ( PARAM[1] + 20 ), PBORE
can be defined as:
Pointset and Geomsets with attributes defined in terms of RPROPs will have their RFLG
flag set to 1. Only elements with RFLG set to 1 need to be pre--evaluated when the item is
added to a model.
DATA elements have an attribute RUSE. If this attribute is set, the PROP attribute (or
default Property DPRO, see Section 10.3.1) cannot be set to a text expression or to an
expression containing the OF notation. RUSE is set (=1) and unset (=0) using the
commands:
SETRuse
UNSETRuse
DATA elements with PROP attributes property which can be used as RPROPs should have
their RUSE flags set. Only elements with RUSE set to 1 need to be pre--evaluated.
The DATA element attribute DPRO can be used to store a default property value. When a
Design element is added to the model, the associated dataset is pre--evaluated and the
default value used if the PPRO attribute in the Dataset unset or cannot be evaluated.
The default property value can be queried from DESIGN using the pseudo--attribute
PRDE.
10.3.2 Querying
Q RPROP datakey
This command will return the result ‘RPROP unset’ if the corresponding PPRO attribute
contains a text string rather than a real value.
The default value of a text or real property value may be queried from a Design component
using the command:
Q PRDE datakey
A list of the datakeys available at a Design item can be obtained using the command:
Q PRLS
To avoid having to transfer component design or specification errors from the Catalogue
database to the Design database before data inconsistencies can be detected, a facility is
provided for checking the main settings of a piping catalogue as you build it in PARAGON.
(This facility is not yet available for checking a structural catalogue.)
The basic command to initiate a database consistency check, using default settings, is
CHECK <gid>
where <gid>, the element below which checks are to be carried out, may be any SPEC,
SELE, SPCO or COMP.
If you start the check from within a specification (SPEC, SELE or SPCO), all components
referenced via the starting element will be checked. If you start the check at component
level (COMP), only that component and elements below it will be checked.
(See Section 11.3 for details of the ways in which you can modify the default checking
procedures.)
At SPEC level:
D Check that no question in the specification is repeated.
D Check that one question in the specification is TYPE.
D From the TYPE reference, check that the GTYPE of the COMP has the same setting.
D From the TYPE reference, check that the SKEY setting of SDTE is correct.
D From the TYPE reference, check that the point set has the correct geometry, as
required by ISODRAFT.
At SPCO level:
D Check that all of the following reference attributes are set: CATREF, DETAIL, MATX,
CMPR, BLTREF. (The BLTREF need be set only if the connection type begins with F or
L.)
You can modify the effect of the CHECK command by using additional syntax so that you
can check different types of catalogue without generating unnecessary errors.
switches Component Reference checking on or off for all component types in a SPCO.
switches Component Reference checking on or off for the specified component type in a
SPCO.
switches Geomset Reference checking on or off for the specified component type.
To query any of the current data consistency checking settings, use the corresponding
command format
Error messages which can result from diagnosed data inconsistencies are as follows:
You must use the following conventions for numbering the P--points of Piping Components
so that ISODRAFT can recognise them:
D For tube components, there must only be one P--point, P1, which defines the bore and
connection type of both ends of the piece of tube.
D For nozzles, the connection P--point (i.e. the P--point for connection to the head or tail
branch) must be P1.
D For two--way components, the arrive and leave P--points must be numbered P1 and
P2 (in either order). For two--way valves, the spindle direction must be indicated by
P3.
D For three--way components, the offline leg must be indicated by P3. The spindle
direction for three--way valves must be specified by using a P--point greater than P3,
which must have its bore unset.
D For four--way components, the two straight--through flows must have P--points
P1/P2 and P3/P4. The spindle direction for four--way valves must be specified by
using a P--point greater than P4, which must have its bore unset.
D For eccentric reducers without a connection point, the flat side must be
indicated by P3. Eccentric reducers with a connection point must use P3, with a
valid bore set, to indicate the connection point and must use P9, with bore unset, for
orientation of the flat side.
P4 P3 P5
P1 P2
See the VANTAGE PDMS ISODRAFT Reference Manual for further details.
It is important that certain items in the Catalogue database are named as they are
referenced from other databases as well as internally. It would be impracticable to allow
system--generated database reference numbers to be referenced as this would lead to
meaningless output from reports and isometrics.
Figure B--1 shows the relationship between the Design, Specification, and Catalogue
databases. Consistency when naming items is important, making cross--database
connections as easily identifiable as possible.
In ISODRAFT, bolt lengths for Piping Components are derived by referring to the SBOL
name. Item detail is picked up from the RTEX attribute of the DTEX and the material is
picked up from the XTEX attribute of the MTEX.
Note that the item code name on an isometric is obtained from the second part of the SPREF
attribute of a Component, i.e. its name in the Specification. In the example in Figure B--1,
the name would be output as FLANWN300100. See the ISODRAFT Reference Manual for
further details.
The list below is not exhaustive and only shows example codes -- it is not mandatory.
The table in the previous section can be used to construct a PDMS Connection
Compatibility Table (CCTA) which sets out all the permissible connection pairs.
The following sample connection table uses the connection list given in the previous section:
NEW CCTAB
NEW COCO /FGDGGD
CTYPE FGD GGD
NEW COCO /TUBBWD
CTYPE TUB BWD
NEW COCO /GGDWGD
CTYPE GGD WGD
NEW COCO /TUBSWF
CTYPE TUB SWF
NEW COCO /SCMSWF
CTYPE SCM SWF
NEW COCO /SCFTUB
CTYPE SCF TUB
The COCO (Connection Compatibility) elements are named so that the allowable
connections are easily queried.
The above table shows, for example, that tube can be connected to a screwed female
connection but not to a screwed male connection.
Different ratings of flanges and gaskets should have different connection attributes to
ensure that different pressure fittings cannot be connected without a warning message
being issued. This principle also applies to different flange face characteristics, e.g. flat face
and raised face: however, there are some exceptions. On some jobs a flat--faced flange on a
piece of equipment may be butted up to a raised--face flange. If this is a common occurrence,
it may be worth inputting a new COCO to allow the connection.
This Appendix gives sample macros for the construction of typical Catalogue Piping Components using
PARAGON.
Each macro starts at CATEGORY level. The view parameters used to produce the drawings shown vary
between each example, and so are not given here. Each drawing has REPRESENTATION settings of
TUBE ON CENTRELINE ON PPOINTS ON NUMBERS ON. Some of the Components are too large to
fit onto a typical view area when drawn at the default SCALE value of 1. Values of 0.5 are suggested for
examples 1 and 3, and 0.05 for example 6.
The definition for each Component includes the possibility of insulation being present, although this is
not drawn. Note how the clash geometry and component geometry have been combined.
OBST 0 CLFL TRUE TUFL TRUE PDIS 0 PAXI - Y PDIA (0.50 * PARAM[1])
NEW SCON
OBST 0 CLFL TRUE TUFL TRUE PDIS (2.5 * PARAM[2]) PDIA (1.6 * PARAM[2])
PAXI X
NEW SDSH
CLFL TRUE TUFL TRUE PDIA (1.6 * PARAM[2]) PHEI (0.8 * PARAM[2])
PDIS (2.5 * PARAM[2]) PAXI X
NEW SCYL
OBST 0 TUFL TRUE PDIS (PARAM[2]) PHEI (-- 1 * PARAM[4])
PDIA (PARAM[3] + IPARAM[1]) PAXI - Y
NEW SCYL COPY PREV PAXI Y
OBST 0 TUFL TRUE PDIS (PARAM[2]) PHEI (-- 1.0 * PARAM[4])
PDIA (PARAM[3] + IPARAM[1]) PAXI Y
NEW LSNO
OBST 0 TUFL TRUE PTDI (PARAM[2] - PARAM[4]) PBDI 0
PTDM (PARAM[3] + IPARAM[1]) PBDM (1 + IPARAM[1])
PAAX - Y PBAX Z
NEW LSNO COPY PREV PAAX Y
NEW LSNO
OBST 0 CLFL TRUE PTDI (PARAM[2]) PBDI 0
PTDM (PARAM[3] + IPARAM[1]) PBDM (1 + IPARAM[1])
PAAX - Y PBAX Z
NEW LSNO COPY PREV PAAX Y
$.
NEW SSPH
COPY PREV PAXI P2
NEW SSPH
OBST 0 CLFL TRUE LEVE 0 2 PDIS 0 PAXI P3
PDIA (PARAM[9])
NEW SCYL
TUFL TRUE PDIS 0 PHEI (-- 2 * PARAM[6])
PDIA (PARAM[3]) PAXI P1
NEW SCYL
TUFL TRUE PDIS 0 PHEI (PARAM[7])
PDIA (PARAM[4]) PAXI X
END
$.
/MWLOBST--51
GOTO GMRE
NEW SRTO
PAAX P1 PBAX P2
PDIA (--1.2 * PARAM[4])
PHEI (PARAM[3])
NEW SSLC OBST 0
CLFL TRUE TUFL TRUE PDIA (PARAM[4]) PHEI (--PARAM[3]) PDIS 0
PAXI P1 PXTS --11.5
NEW SSLC OBST 0
CLFL TRUE TUFL TRUE PDIA (PARAM[4]) PHEI (--PARAM[3]) PDIS 0
PAXI P2 PXTS 11.5
NEW SSLC OBST 0
CLFL TRUE TUFL TRUE PDIA (PARAM[4]) PHEI (--2 * PARAM[3])
PDIS (PARAM[3]) PAXI P3 PXTS --11.5 PXBS 11.5
NEW SSLC COPY PREV PAXI P4
NEW SSLC COPY PREV PAXI P5
END
$.
PARAGON Syntax:
NEW PTSE /PBOXI2
NEW PTAX
PCON BWD NUM 1 PBOR (PARAM[1]) PDIS 0 PAXI - Y
END OF END
NEW GMSE /GBOXI2
NEW BOXI
PAXI P1 PXLE (PARAM[3]) PZLE (PARAM[2]) CLFL TRUE TUFL TRUE
END OF END
NEW PTSE /PELBO
NEW PTAX
PCON BWD NUM 1 PBOR (PARAM[1]) PDIS 250
PAXI - Y
END
NEW PTAX
PCON BWD NUM 2 PBOR (PARAM[1]) PDIS 250
PAXI X
END OF END
NEW GMSE /GELBO
NEW SRTO
CLFL TRUE TUFL TRUE PAAX P1 PBAX P2 PDIA (PARAM[2])
PHEI (PARAM[3])
END OF END
NEW PTSE /PVELBO
NEW PTAX
PCON BWD NUM 1 PBOR (PARAM[1]) PDIS 250
PAXI - Y
END
NEW PTAX
PCON BWD NUM 2 PBOR (PARAM[1]) PDIS 250
PAXI Z
END OF END
SPECON Macro:
NEW SPECIFICATION /BOXI.SPEC
MATREF =0
FLUREF =0
RATING 0.000
LINETYPE NUL
HEADING
TYPE NAME PBOR0 CATREF DETAIL MATXT CMPREF BLTREF
TUBE */D300X100 300100.0 /BOX101 =0 =0 =0 =0
HEADING
TYPE NAME PBOR0 STYP CATREF DETAIL MATXT CMPRE BLTREF
ELBO */HB300X100 300100.0 H /HELBO101 =0 =0 =0 =0
ELBO */VB300X100 300100.0 V /VELBO101 =0 =0 =0 =0
HEADING
TYPE NAME PBOR0 CATREF DETAIL MATXT CMPREF BLTREF
WELD */W300X100 300100.0 /BWELD101 =0 =0 =0 =0
$.
DESIGN Syntax:
NEW PIPE
SPEC BOXI.SPEC
NEW BRAN /BOXIBRAN
HPOS E0 HBOR 300100 HDIR N HCON BWD
TPOS E2500 N7000 U1000 TDIR S TBOR 300100 TCON BWD
NEW WELD SEL CONN TO PH AND P0 IS U
SPRE /BOXI.SPEC/W300X100 LSTU /BOXI.SPEC/D300X100 ORIF TRUE POSF TRUE
NEW ELBO SEL WI STYP V
THRO N5000 DIR U
NEW ELBO SEL WI STYP H
THRO U1000 DIR E
NEW ELBO SEL WI STYP V
THRO PT DIR N
NEW WELD SEL CONN TO PT AND P0 IS E
END
Note that it is assumed that a COCO element allowing BWD to BWD connections already exists in your
database.
This appendix contains a glossary of the element types which you can use in PARAGON,
and a list of them grouped according to their function. Some element types can be created
and deleted in PARAGON, and have their standard attributes of NAME and LOCK
changed, but must have their particular attributes set by other PDMS modules. These are
indicated by references to the appropriate manuals.
The list of element types is the list of ‘special nouns’ for PARAGON (its <snoun> syntax
diagram).
D.1 Glossary
3D Pointset elements:
PTSEt PTAXi PTCAr PTMIx
3D Geomset elements:
GMSEt SBOX SDISc SDISk SCONe
LSNOut SDSH BOXIng SSLCylinder SSPHere
LCYLinder SCYLinder LINEs SCTOrus SRTOrus
TUBE LPYRamid SEXTrusion SREVolution SLOOp
SVERtex
Dataset elements:
DTSEt DATA
Piping Components:
SCOMponent COMPonent number
Profile Components:
SPRFile PROFile number
Joint Components:
SJOInt JOINt number
Fitting Components:
SFITting (NOT FITTing number)
Units elements:
UNIT MSET MTYP ATLIst USECtion
UDEFinition
F M
filename, 2--4 MEMBER, 5--3
GETWORK, 3--2
GMSET, 4--5, 7--5, 8--19
N
NA, 8--17
GMSSET, 4--6, 7--25, 8--21
name, 2--4
GOTO, 5--3
NEW, 8--2
NEXT, 5--3
I NGMSET, 4--6, 7--24
NUMBER, 8--15
INSTALL, 3--1
NUMBERS, 6--24
INSULATION, 6--23
integer, 2--3
O
IPARAM, 4--8, 8--4
OBST, 7--6, 7--26
OBSTRUCTION, 6--6, 6--23
J OPARAM, 4--8
OWNER, 5--2
JOIN, 4--7, 4--13
P
L PAAX, 8--23
LAST, 5--3 PARAGON, 3--1
LCYL, 7--10 PARAM, 4--8, 8--4
PAXI, 8--23
LENGTH, 6--24, 6--25
PBORE, 8--15
letter, 2--3
PCON, B--1, B--4
LEVEL, 6--6, 6--22
PCONNECTION, 8--15
LINE, 7--15
PDISTANCE, 8--14
LPYR, 7--16 PKEY, 6--25, 8--17, 8--18
LSNO, 7--19 PLAXI, 8--17
LTAB, 9--4 PLINE, 7--3, 8--16
U V
value, 2--3
UDEF, 9--5 varid, 2--4
VISIBLE, 3--6
UNIT, 9--5
UNITS, 9--6 W
USEC, 9--5 word, 2--3