Professional Documents
Culture Documents
Patran 2014 Doc PCL Reference
Patran 2014 Doc PCL Reference
Patran 2014 Doc PCL Reference
Japan Asia-Pacific
MSC Software Japan Ltd. MSC Software (S) Pte. Ltd.
Shinjuku First West 8F 100 Beach Road
23-7 Nishi Shinjuku #16-05 Shaw Tower
1-Chome, Shinjuku-Ku Singapore 189702
Tokyo 160-0023, JAPAN Telephone: 65-6272-0082
Telephone: (81) (3)-6911-1200 Email: APAC.Contact@mscsoftware.com
Email: MSCJ.Market@mscsoftware.com
Worldwide Web
www.mscsoftware.com
Support
http://www.mscsoftware.com/Contents/Services/Technical-Support/Contact-Technical-Support.aspx
Disclaimer
This documentation, as well as the software described in it, is furnished under license and may be used only in accordance with the
terms of such license.
MSC Software Corporation reserves the right to make changes in specifications and other information contained in this document
without prior notice.
The concepts, methods, and examples presented in this text are for illustrative and educational purposes only, and are not intended
to be exhaustive or to apply to any particular engineering problem or design. MSC Software Corporation assumes no liability or
responsibility to any person or company for direct or indirect damages resulting from the use of any information contained herein.
User Documentation: Copyright 2014 MSC Software Corporation. Printed in U.S.A. All Rights Reserved.
This notice shall be marked on any reproduction of this documentation, in whole or in part. Any reproduction or distribution of this
document, in whole or in part, without the prior written consent of MSC Software Corporation is prohibited.
This software may contain certain third-party software that is protected by copyright and licensed from MSC Software suppliers.
Additional terms and conditions and/or notices may apply for certain third party software. Such additional third party software terms
and conditions and/or notices may be set forth in documentation and/or at http://www.mscsoftware.com/thirdpartysoftware (or
successor website designated by MSC from time to time).
METIS is copyrighted by the regents of the University of Minnesota. A copy of the METIS product documentation is included with this
installation. Please see "A Fast and High Quality Multilevel Scheme for Partitioning Irregular Graphs". George Karypis and Vipin
Kumar. SIAM Journal on Scientific Computing, Vol. 20, No. 1, pp. 359-392, 1999.
MSC, MSC Nastran, MD Nastran, MSC Fatigue, Marc, Patran, Dytran, and Laminate Modeler are trademarks or registered trademarks
of MSC Software Corporation in the United States and/or other countries.
NASTRAN is a registered trademark of NASA. PAM-CRASH is a trademark or registered trademark of ESI Group. SAMCEF is a
trademark or registered trademark of Samtech SA. LS-DYNA is a trademark or registered trademark of Livermore Software
Technology Corporation. ANSYS is a registered trademark of SAS IP, Inc., a wholly owned subsidiary of ANSYS Inc. ACIS is a
registered trademark of Spatial Technology, Inc. ABAQUS, and CATIA are registered trademark of Dassault Systemes, SA. EUCLID
is a registered trademark of Matra Datavision Corporation. FLEXlm and FlexNet Publisher are trademarks or registered trademarks of
Flexera Software. HPGL is a trademark of Hewlett Packard. PostScript is a registered trademark of Adobe Systems, Inc. PTC, CADDS
and Pro/ENGINEER are trademarks or registered trademarks of Parametric Technology Corporation or its subsidiaries in the United
States and/or other countries. Unigraphics, Parasolid and I-DEAS are registered trademarks of Siemens Product Lifecycle
Management, Inc. All other brand names, product names or trademarks belong to their respective owners.
P3:V2014:Z:PCL:Z:DC-REF-PDF
Contents
PCL Reference Manual
1 Introduction
Introduction 2
Error Handling 19
Solving Problems 20
2 Basic Functions
Introduction 22
File Menu 23
3 Geometry Functions
Introduction 476
Utlities 999
Utilities 1244
CONTENTS v
Materials 1325
Fields 1355
7 XY Plot Functions
Introduction 1616
8 FlightLoads Functions
Introduction 1750
9 Preference Functions
Introduction 1810
11 Status Messages
Introduction 1878
Status Conditions 1879
I/O and Import Status Conditions 1880
Analytical Solids Modeling Status Conditions 1887
Finite Element Model Status Conditions 1900
Results Status Conditions 1929
Application Interface Status Conditions 1949
PCL Status Conditions 1997
Core Status Conditions 2002
XY Status Conditions 2004
Group Status Conditions 2007
Preference Status Conditions 2015
Database Status Conditions 2016
List Processor Status Conditions 2024
Graphics Manager Status Conditions 2038
Application Status Conditions 2044
List Manager Status Conditions 2045
ID Dispenser Status Conditions 2046
Mesher Status Conditions 2047
IGES Status Conditions 2051
Unigraphics Status Conditions 2051
viii PCL Reference Manual
1 Introduction
Introduction 2
Patran User Interface Description 3
Session and Journal Files 4
Features of Session and Journal Files 5
Interpreting Session and Journal Files 7
Session Files to PCL Files 8
Function Description Organization 17
Error Handling 19
Solving Problems 20
2 PCL Reference Manual
Introduction
Introduction
This manual provides a detailed description of many of the PCL functions built-in to Patran that are
available to the user. Many of these functions can be used by themselves, combined to build user
functions, or be used to provide the functionality behind the forms and pull down menus that are part of
a user interface. These functions can be used at the command line or in a file to extend and customize
Patran. This manual provides a partial list of the functions that can be listed as entries in session and
journal files, allowing it to be used as an aid to the interpretation of these files.
This manual is broken up into ten chapters that describe:
All entries made to both the journal and session file take the form of a PCL, or Patran Command
Language statement. PCL provides the glue that ties all of the inputs from a user to the underlying code
that composes Patran and provides the tools needed to modify and customize Patran.
Chapter 1: Introduction 5
Features of Session and Journal Files
These files can be played back through Patran, repeating the operations listed in the files. There are some
limitations caused by what is recorded in these files and how they are played back. Some editing may be
required to work around these limitations to get the desired results from a play back of these files.
One of the limitations of the these files are in the area of file paths. When Patran opens a database, both
the path to the file and the file name are recorded in journal and session files as literal strings (the listing
has been reformatted to better fit the page):
uil_file_rebuild.start @
(/some_other_system/patran/patran3/template.db, @
/my_system/wriggler.db)
The source file path for the template file (/some_other_system/patran /patran3/template.db) was
applied either by the user when the template file for the database was specified or from the default path
and file settings. The default path is /patran/patran3 but can be modified with the environment variable
P3_HOME. The default template file name is template.db. If this session or journal file is executed on
a different machine these path settings will be different and this file will require editing to make this
command work.
When a command in a session or journal file spawns another process, the results of executing a journal
or session file may create results that are different from the Patran session that created the original file.
If a session file passes a model to the translator for MSC Nastran, it will set up the files that MSC Nastran
needs and start MSC Nastran. MSC Nastran runs as a separate process and Patran may or may not wait
until the MSC Nastran process is done. If the session file is set not to wait for the process to finish, it will
immediately move on to the next operation. If the next operation is to read the results of the MSC Nastran
process which do not yet exist, playback of the journal or session file will fail. This situation will again
require some editing to fix.
During a Patran session, all operations are recorded in the journal and the session files. When an
operation requires user input through a popup form, the answer provided by the user is always recorded
in the session file but is sometimes not recorded in the journal file. The instances where user input is
required, but not recorded in journal files, can cause problems when a journal file is played back through
Patran. When the journal file playback gets to the point where user input is required, playback will stop
until the user input is provided. If the user input is different than that provided when the journal file was
made, the results of the playback will be modified.
6 PCL Reference Manual
Features of Session and Journal Files
Journal and session files not only record the operations executed by the user but also the exact order in
which those operations where executed by Patran. The order in which these operations are recorded can
affect the behavior of the playback of the journal and session files in which these operations are recorded.
For example: creating two surfaces in a model by using Geometry, Create, Surface, XYZ and
using the same vector and origin coordinate lists for both surfaces will cause a popup form to appear
warning the user of the duplicate surfaces created by the operation. If the user repositions or resizes the
model viewport while the popup form is on the screen and then answers the popup form after modifying
the viewport, the PCL commands to modify the viewport will be recorded in the journal and session file
before the reply to the popup form. When the journal or session file is played back using Patran, the reply
the user supplied will be lost because of the order in which the operation commands where recorded and
the user will be prompted with a popup form to supply the missing information.
These issues with journal and session files do not limit the usefulness of these files but they do point
out areas where the playback of a journal or session file may yield results that are different from what
was expected.
Chapter 1: Introduction 7
Interpreting Session and Journal Files
and:
elementprops_create(ps1, 71, 25, 30, 1, 1, 20, @
[13, 21, 4124, 4126, 4125],
In this example fragment, the eighth argument, [13, 21, 4124, 4126, 4125], is an array of five integers.
If you are in doubt about the interpretation of a literal argument in a journal or session file, the argument
can be passed to the PCL command dump, which will list what kind of argument has been passed in
the history window.
For example:
The dump command can be a powerful tool to help better understand the contents of a journal or
session file.
8 PCL Reference Manual
Session Files to PCL Files
pcc.goto_clevis("pcc_construct_model.xml","pcc.xml","db_not_open")
pcc.reset_clevis("pcc_construct_model.xml")
AAI.html_calls("FUNC:pcc.goto_geometry;STR:pcc_geometry.xio")
pcc.goto_geometry("pcc_geometry.xio")
AASTATE.store_objectives()
pcc_geom.settings_display(FALSE)
$#~ STRING s_cmnd_switch: uil_pref_picking.rectpoly_option(
"1","ON" )
AASTATE.store_objectives()
pcc_geom.settings_hide()
pcc_geom.pref_display(FALSE)
$#~ STRING s_cmnd_switch: uil_pref_geometry.switch_value(
"25","ON" )
pref_geometry_set_v4( FALSE, TRUE, FALSE, TRUE, 39.370079,
FALSE, TRUE )
AASTATE.store_objectives()
pcc_geom.pref_hide()
pcc_geom.pnt_inner_display(FALSE)
STRING asm_create_grid_xyz_created_ids[VIRTUAL]
asm_const_grid_xyz( "1", "[ 1 0 0]", "Coord 0", @
asm_create_grid_xyz_created_ids )
$# 1 Point created: Point 1
AASTATE.store_objectives()
pcc_geom.geometry_hide()
pcc_geom.rad_inner_display("45.0","0.0",FALSE)
STRING sgm_sweep_curve_rev_created_ids[VIRTUAL]
sgm_const_curve_revolve( "1", "Coord 0.3", 45., 0., "Coord
0", "Point 1", @
sgm_sweep_curve_rev_created_ids )
$# 1 Curve Created: Curve 1
sgm_const_curve_revolve( "2", "Coord 0.3", 45., 45., "Coord
0", "Point 1", @
sgm_sweep_curve_rev_created_ids )
$# 1 Curve Created: Curve 2
sgm_const_curve_revolve( "3", "Coord 0.3", 45., 90., "Coord
0", "Point 1", @
sgm_sweep_curve_rev_created_ids )
$# 1 Curve Created: Curve 3
sgm_const_curve_revolve( "4", "Coord 0.3", 45., 135., "Coord
0", "Point 1", @
sgm_sweep_curve_rev_created_ids )
$# 1 Curve Created: Curve 4
AASTATE.store_objectives()
pcc_geom.geometry_hide()
pcc_geom.coord_display(FALSE)
STRING asm_create_cord_3po_created_ids[VIRTUAL]
asm_const_coord_3point( "1", "Coord 0", 2, "[0 0 0]", "[0 0
1]", "[1 0 0]", @
asm_create_cord_3po_created_ids )
$# 1 Coord created: Coord 1
AASTATE.store_objectives()
pcc_geom.geometry_hide()
pcc_geom.rad_outer_display(FALSE)
$#~ STRING s_cmnd_switch:
sgm_transform_curve_translate.trans_option( "curv","ON" )
$# Warning reported from application Geometry
$# Curvilinear transformation requires parametric cubic
geometry,
10 PCL Reference Manual
Session Files to PCL Files
pcc_geom.bdy_crv_srf_display("Curve~3","Construct~2PointCurve(Evaluate~
Geo" // @
"metry(Point~8))(Evaluate~Geometry(Point~10))",FALSE)
STRING sgm_surface_2curve_created_ids[VIRTUAL]
sgm_const_surface_2curve( "5", "Curve 3", @
"Construct 2PointCurve(Evaluate Geometry(Point 8))(Evaluate
Geometry(Point" // @
" 10))", sgm_surface_2curve_created_ids )
$# 1 Surface Created: Surface 5
AASTATE.store_objectives()
pcc_geom.geometry_hide()
pcc_geom.solid_display(FALSE)
STRING sgm_sweep_solid_nor_created_ids[VIRTUAL]
sgm_const_solid_normal( "1", "0.25", "", "", "", FALSE,
"Surface 1:5", @
sgm_sweep_solid_nor_created_ids )
$# 5 Solids Created: Solids 1:5
AASTATE.store_objectives()
pcc_geom.geometry_hide()
pcc_geom.mirror_bot_display(FALSE)
STRING sgm_transform_solid_created_ids[VIRTUAL]
ge_transform_mirror( "6", "solid", "Coord 0.2", 0., TRUE,
FALSE, "Solid 1:5", @
Chapter 1: Introduction 11
Session Files to PCL Files
sgm_transform_solid_created_ids )
$# 5 Solids Created: Solids 6:10
AASTATE.store_objectives()
pcc_geom.geometry_hide()
pcc_geom.remain_solid_display(FALSE)
$#~ STRING s_sel_cmnd:
sgm_transform_trans_cart.eval_magnitude("VALUE_CHANGED")
STRING sgm_transform_solid_created_ids[VIRTUAL]
ge_transform_translate_v1( "11", "solid", "<0,0,-1>", 0.25,
FALSE, "Coord 0", @
2, FALSE, "Solid 1 6", sgm_transform_solid_created_ids )
$# 4 Solids Created: Solids 11:14
AASTATE.store_objectives()
pcc_geom.geometry_hide()
pcc_geom.remain_clevis_display(FALSE)
$#~ STRING s_sel_cmnd:
sgm_transform_trans_cart.eval_magnitude("VALUE_CHANGED")
STRING sgm_transform_solid_created_ids[VIRTUAL]
ge_transform_translate_v1( "15", "solid", @
"Construct 2PointVector(Evaluate Geometry(Point 10))(Evaluate
Geometry(Poi" // @
"nt 40))", 0.5, FALSE, "Coord 0", 1, FALSE, "Solid 2:5 7:10",
@
sgm_transform_solid_created_ids )
$# 8 Solids Created: Solids 15:22
uil_file_close.goquit( )
$# Journal file stopped recording at 02-Mar-09 09:58:21
$# Session file patran.ses.01 stopped recording at 02-Mar-09
09:58:21
Edit this session file by removing all unneeded functions such as all "AASTATE.XXX", "AAUI.xxx",
"AAI.xxx" and "pcc_xxx.xxx" functions. Copy the remainder into a file with a .PCL extension. Add the
"FUNCTION" and "END FUNCTION" keywords around the code. Decide what you want for inputs and
outputs you need for the function and edit the code into what you need as in the following example. Much
of the editing will replace hard coded geometry id values with the id values returned by function calls
used to make the preceding geometry.
For this example the ability to define the location of the clevis and the diameter of the hole in the clevis
where chosen as inputs.
Note: Note that this function is incomplete. Some of the items that could be added to this function
are:
REAL r_dia
REAL r_x
REAL r_y
12 PCL Reference Manual
Session Files to PCL Files
REAL r_z
INTEGER i_end
INTEGER i_strt
REAL r_base_x
REAL r_base_y
REAL r_base_z
STRING coord_id_01 [VIRTUAL]
STRING coord_id_02 [VIRTUAL]
STRING created_ids [VIRTUAL]
STRING curve_id_1 [VIRTUAL]
STRING curve_id_2 [VIRTUAL]
STRING curve_id_3 [VIRTUAL]
STRING curve_id_4 [VIRTUAL]
STRING curve_id_56 [VIRTUAL]
STRING deleted_ids [VIRTUAL]
STRING line_ids [VIRTUAL]
STRING point_id [VIRTUAL]
STRING s_temp [VIRTUAL]
STRING s_vect [VIRTUAL]
STRING solid_ids [VIRTUAL]
STRING solid_ids_16 [VIRTUAL]
STRING solid_ids_610 [VIRTUAL]
STRING solid_ids_lst [VIRTUAL]
STRING surface_id_1 [VIRTUAL]
STRING surface_id_15 [VIRTUAL]
r_base_x = r_x
r_base_y = r_y + 2.0
14 PCL Reference Manual
Session Files to PCL Files
r_base_z = r_z
i_end =
str_length ( solid_ids_610 )
i_strt =
str_index ( solid_ids_610, " " )
s_temp = str_substr ( solid_ids_610, i_strt, i_end )
i_strt = str_to_integer ( s_temp )
solid_ids_16 = solid_ids_16 // " " // str_from_integer (
i_strt )
i_end =
str_length ( solid_ids_610 )
i_strt =
str_index ( solid_ids_610, " " )
s_temp = str_substr ( solid_ids_610, i_strt, i_end )
i_strt = str_to_integer ( s_temp )
i_strt = i_strt + 1
solid_ids_lst = solid_ids_lst // str_from_integer ( i_strt
) // ":"
i_end =
str_length ( solid_ids_610 )
i_strt =
str_index ( solid_ids_610, ":" ) + 1
s_temp = str_substr ( solid_ids_610, i_strt, i_end )
i_strt = str_to_integer ( s_temp )
solid_ids_lst = solid_ids_lst // str_from_integer ( i_strt
)
END FUNCTION
uil_file_close.go ( )
uil_file_new.go( "", "db_session_to_pcl.db" )
$? YES 36000002
gu_fit_view ( )
End of File.
Chapter 1: Introduction 17
Function Description Organization
The Function Name and Argument List: This heading, which starts the description of the function,
identifies the name of the function and provides a list of
arguments passed to the function. The argument list
identifies the order in which they are passed to the function
and by the names used for the arguments provide some
information about how the arguments are used.
The Description Section: This section provides a short description of what the
function does and is to be used for.
The Input Section: This section lists the values from the argument list at the top
of the function description that are used for passing input
information to the function being called. Each entry in this
section will list the data type for that argument, the name of
the argument, a description of the use of each argument, and
an enumeration of the values or the range of values that can
be used with each argument. The data types allowed in this
section are REAL, INTEGER, LOGICAL, STRING, and
WIDGET. Each argument listing will make use of square
brackets [], parenthesis () and the VIRTUAL keyword
to identify the lengths of strings and the sizes of arrays
when it is appropriate to do so. If the enumerated list of
values that can be used with an argument is longer than
about five entries, the list of allowed argument values will
be listed as part of the remarks for the section.
18 PCL Reference Manual
Function Description Organization
The Output Section: This section lists the values from the argument list at the top
of the function description that are used for passing output
information to the calling function. Each entry in this
section will list the data type for that argument, the name of
the argument, a description of the use of each argument, and
an enumeration of the values or the range of values that can
be used with each argument. The data types allowed in this
section are REAL, INTEGER, LOGICAL, STRING, and
WIDGET. Each argument listing will make use of square
brackets [], parenthesis () and the VIRTUAL keyword
to identify the lengths of strings and the sizes of arrays
when it is appropriate to do so. If the enumerated list of
values that can be used with an argument is longer than
about five entries, the list of allowed argument values will
be listed as part of the remarks for the section.
This section will also list the <return value> for the
function, if the function has one.
Error Conditions: This section is used to enumerate the list of numbers that
can be returned to report the status of a function through the
<return value> of a function and the messages from the
status message database that can be associated with each
number. Every attempt has been made to make these lists as
complete as possible but it is often impractical or
impossible to do so. This section will contain a statement
marking an error condition list as being incomplete when
possible.
The Remarks Section: This section is used to do several things: provide
enumerated lists of values that can be used with inputs or
are expected to be returned by outputs if they are too long
for the Input and Output sections, list the messages that
can be displayed in a popup form, and list any other details
or information about the function that may be useful to a
user.
Many times the information in the Remarks section of a
function description will seem redundant as it will duplicate
much of the information listed in the Error Conditions
section. The information is listed twice because it is being
used to do two separate jobs: present information through a
popup form and it is being used as a return value for
program execution flow control.
The Examples Section: This section of the function description contain a reference
to a .pcl source file listing that makes use of the function
being described.
Chapter 1: Introduction 19
Error Handling
Error Handling
All code can generate errors. In recognition of this, the PCL functions listed in this manual make use of
a straight forward mechanism that passes information about the status of a function back from the
function that has been called to the calling function. This is done through the <return value> that most
functions supply.
The general convention followed is that if something happens that prevents a function from successfully
completing the job that it was designed to do it will return a positive non-zero integer number. If it
completes its job successfully, it will return a value of 0.
This returned integer value can then be put to use. It can be used in an IF statement to control the flow
of the path of execution for your code, it can be used to trigger the a return out of the calling function, or
it can be used to break out of a FOR or WHILE loop. The returned value can be used in whatever manner
is appropriate for the design of the code being written. A good practice to follow is to design your code
so that it marks any problem that prevents your function from completing its job by returning an error
code that is returned by that status condition only. For example: the same returned status value should
not be used to indicate that a file was not found because of an invalid path and that a file was not found
because of an invalid path name. Using a unique status code for the return status of a function provides
information about what caused the error and where the error occurred in a manner that can greatly
simplify debugging your code. A list of all of the messages in the status message database is
provided at the end of this manual as an aid in selecting return codes that are appropriate for specific
status conditions.
Most of the <return values> that are returned by the functions in this manual have messages associated
with them. Status messages are all kept in a status message database that can be accessed through the use
of several functions: msg_get_string(), user_message(), msg_to_form(), and msg_to_text(). The
msg_get_string() is used to return a message from the message database to a string. The user_message()
function takes a message code and displays the corresponding message in the history window. The
msg_to_form() function can be used to get a message from the message database and display it a popup
form; this is the mechanism that is used to create the popup forms that are listed in the Remarks section
of the function descriptions. The msg_to_text() function can be used to write messages from the message
database to a file.
All of these functions are provided to create a rich set of tools that can be used by the code designer to
be flexible in presenting error and status information as needed.
20 PCL Reference Manual
Solving Problems
Solving Problems
Just as all code can generate errors, all errors have a specific cause. A common source of errors and
mysterious core dumps with PCL code is the misuse of string lengths and the sizes of arrays. There are
no guarantees that a function will check the length of a string or the size of an array that is passed into
the function. This can lead to a memory overwrite that will cause a core dump. Often the memory
overwrite will not cause the code to fail immediately, it just sets the stage for a crash in an unrelated piece
of code later somewhere else in your program. If the cause of a crash or core dump cannot seem to be
isolated or it seems to move around for no discernible reason, check the lengths of strings and the sizes
of arrays being passed as arguments to functions. Verify that calls to functions that dynamically allocated
or free memory being used correctly and appropriately.
Chapter 2: Basic Functions
PCL Reference Manual
2 Basic Functions
Introduction 22
File Menu 23
Group Menu 128
Viewport Menu 224
Viewing Menu 181
Display Menu 265
Tools Menu 357
22 PCL Reference Manual
Introduction
Introduction
This chapter documents the functions that are used in the implementation of the File, Group, Viewport,
Viewing, Display and Tools items on the menu bar.
This chapter presents function descriptions in six separate sections:
File Menu This section is used to describe some of the functions used to import
and export model geometry files to and from files that can be used by
various types of CAD systems.
Group Menu This section is used to describe functions that are used to create,
delete, modify and transform groups of geometric and finite element
model entities.
Viewport Menu This section is used to describe functions that are used to create,
delete, modify and retrieve the settings of named viewports.
Viewing Menu This section is used to describe functions that are used to create,
delete, modify and retrieve the settings of named views.
Display Menu This section is used to describe functions that are used to control what
and how geometric and finite element model entities are displayed in
a viewport.
Tools Menu This section is used to describe functions that used to create and
manipulate lists of geometric and finite element model entities using
the list processor and the list processor format. It is also used to
describe some of the functions that can be used to create and report
the mass properties associated with a model.
Chapter 2: Basic Functions 23
File Menu
File Menu
This section is used to describe some of the functions used to import and export model geometry files to
and from files that can be used by various types of CAD systems
Description:
This function is used to import a neutral file.
Input:
STRING file_name[] This value specifies the name of the neutral file to be imported.
STRING group_name[] This value specifies the name of the group to which the
imported geometry will be added.
LOGICAL entity_flags(35) This value specifies an array of flags identifying the types of
entities to be imported from the neutral file. See the remarks
below for more information.
INTEGER minimum_id(35) This value specifies an array of values used to set the minimum
ID values for the entities in the current database.
INTEGER maximum_id(35) This value specifies an array of values used to set maximum ID
value for the entities in the current database.
INTEGER offset(35) This value specifies user supplied entity label or id offsets.
Output:
INTEGER <Return Value> This function always returns a value of 0.
Error Conditions:
None.
Remarks:
The input value entity_flags controls which entity types are to be exported to the neutral file. The offset
into the array identifies the data type. Setting the value at that offset to TRUE will cause that entity type
to be written to the neutral file. The following table identifies the offset into the array for each entity type
24 PCL Reference Manual
File Menu
This function can display an information popup message form with the following messages:
This function can display a query yes or no popup message form with the following message:
25000020 Do you want the Neutral File printed to the terminal as it is being read?
This function can display a fatal error popup message if an error value is returned by the function:
See the listing for this function Broken, Obsolete, Modified and New Functions for further information.
Example:
Description:
This function will generate a Patran 2.5 format neutral file from a Patran database.
Input:
STRING file_name[] This value specifies the name of the neutral file to
be written.
STRING title[] This value specifies the title to put in the packet 25
title field.
LOGICAL entity_flags(35) This value specifies an array of flags used to identify
the specific entity types to be exported. See the
remarks below for more information.
LOGICAL all_groups This value should be set TRUE if the entire model is
to be exported, FALSE if only selected groups are to
be exported.
INTEGER number_of_groups If exporting selected groups, this value is used to
indicate the number of groups being written to the
neutral file.
INTEGER group_entity_ids(number_of If exporting selected groups, this value is used to
_groups) pass the list of group IDs for the entities being
written to the neutral file.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This function may return a nonzero value if an error occurs.
26 PCL Reference Manual
File Menu
Remarks:
The input value entity_flags controls which entity types are to be exported to the neutral file. The offset
into the array identifies the data type. Setting the value at that offset to TRUE will cause that entity type
to be written to the neutral file. The following table identifies the offset into the array for each entity type
If more than 1000 entities are being written to the file of any one type, a percent complete bar is
displayed. Messages get printed to the command window indicating the number of successful
packets read.
This function will display an information popup message form if opening the neutral file and writing the
packet 25 and title information fails:
This function will display an information popup message form at the completion of the operation:
This function will display a warning popup message form if reading the database for coordinate, nodes,
elements, properties, materials, mpcs, loads and boundary conditions fails:
45000002 Error writing Finite Element Model. Will try to complete Neutral File.
This function will display a warning popup message form if reading the named components from the
database and writing them to the neutral file fails:
45000003 Error writing Named Components. Aborting FEM portion of Neutral File.
Will try to complete writing geometry, if any.
Example:
Please see neutral_export2 (p. 10) in the PCL Reference Manual Examples.
28 PCL Reference Manual
File Menu
Description:
This function will retrieve a string of a CAD name attribute for a Patran entity. The Patran identifier
and entity type are used to lookup the associated CAD name attribute.
Input:
INTEGER p3id
The Patran id of the entity used to look up the
associated CAD name attribute.
INTEGER p3type
The Patran entity type. Valid entity type values are:
1 for a point,
2 for a curve,
4 for a solid.
Output:
STRING attribute The CAD name attribute.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
1 Out of memory
10 A corrupt attribute was detected.
255 Invalid string length.
257 Cant reallocate virtual string array.
259 Not a virtual string.
13000211 Virtual memory has been exhausted.
13000212 There is an error interacting with the PERSISTENT_MEMORY relation in the
database.
13000213 A database lookup failed to locate the target index key.
<non-zero> Attribute not found
Description:
This function will retrieve all CAD string attributes for a Patran entity. The Patran identifier and entity
type are used to look up the associated CAD string attributes.
Input:
INTEGER p3id
The Patran id of the entity used to look up the
associated CAD name attributes.
INTEGER p3type
The Patran entity type. Valid entity type values are:
1 for a point,
2 for a curve,
4 for a solid.
Output:
INTEGER attrib_count The number of string attributes associated to the
referenced Patran entity.
STRING[] attrib_titles An array of CAD name attribute titles.
STRING[] attrib_values An array of CAD name attribute values.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
1 Out of memory
10 A corrupt attribute was detected.
255 Invalid string length.
257 Cant reallocate virtual string array.
259 Not a virtual string.
13000211 Virtual memory has been exhausted.
13000212 There is an error interacting with the PERSISTENT_MEMORY relation in
the database.
13000213 A database lookup failed to locate the target index key.
<non-zero> Attribute not found
30 PCL Reference Manual
File Menu
Description:
This function imports geometry information from a file using the express neutral file format.
Input:
STRING option_file[] This value specifies the name of the express
options file which determines entity and group
filters, etc. It is optional and can be input as an
empty string or .
STRING file_name[] This value specifies the name of the express file to
import.
LOGICAL geometry_tracking This value should be set to TRUE if a log file of
geometry tracking is to be created.
LOGICAL reset_tolerance This value should be set to TRUE if the user will
allow Patran to reset the tolerances.
LOGICAL tolerance_prompt This value should be set to TRUE if the user would
like to be prompted before tolerances are changed.
LOGICAL return_entity_count
This value should be set to TRUE if Patran is to
return a count of entities created in the entities
array.
Output:
INTEGER entities (64)(2) This value is an array of entity types and the
number of types in the express file.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-9999 This is an internal status condition. There is no corresponding status message in the
message database.
55001011 The file option is not valid or not supported.
Chapter 2: Basic Functions 31
File Menu
Remarks:
This function will import model geometry and finite element information from a file using the express
file format, place them in the Patran database, and display them in the current viewport. It will display a
popup form that will list a summary of the number of entities accessed from the express file.
The PCL function p3_express_import_exit() must be called to properly terminate this import operation.
See the function listing for the p3_express_options_file for more information on the express options file
entered as the input value option_file.
See Importing Express Neutral Files (p. 101) in the Patran Reference Manual for further information.
This function can produce fatal popup message forms.
Example:
Please see p3_express_import (p. 11) in the PCL Reference Manual Examples.
Description:
This function previews geometry information from a file using the express neutral file format.
Input:
STRING option_file[] This value specifies the name of the express
options file which determines entity and group
filters, etc. It is optional and can be input as an
empty string or .
STRING file_name[] This value specifies the name of the express file to
import.
LOGICAL tolerance_check This value should be set to TRUE if the tolerance
needs to be checked.
LOGICAL return_entity_count This value should be set to TRUE if this function
is to return a count of entities created in the entities
array.
Output:
INTEGER entities (64)(2) This value returns an array of entity types and the
number of types in the express file.
STRING cad_attributes[2](256) This value returns the CAD system and model
name.
REAL cad_tolerance This value returns the calculated CAD tolerance.
32 PCL Reference Manual
File Menu
REAL shortest_curve_length This value returns the shortest curve length for
non-degenerate curves in the model. This value is
calculated only if the input value tolerance_check
is set to TRUE.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-9999 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function will read information about the model geometry and finite element information in a file
using the express file format. It will display a popup form that will list a summary of the number of
entities accessed from the express file.
The PCL function p3_express_import_exit() must be called to properly terminate this import operation.
See the function listing for the p3_express_options_file for more information on the express options file
entered as the input value option_file.
See Importing Express Neutral Files (p. 101) in the Patran Reference Manual for further information.
This function can produce fatal popup message forms.
This function can produce a warning popup message form with the following message:
55001012 %I% Error(s) encountered during generation of the import file in the foreign
sending system. These errors are detailed in the log file%A%.
Example:
Please see p3_express_import_preview (p. 12) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 33
File Menu
Description:
This function is called to terminate an express neutral file import operation.
Input:
LOGICAL delete_option_file This value, when set to TRUE, will cause the express
options file to be deleted.
LOGICAL delete_express_file This value, when set to TRUE, will cause the express
neutral import file to be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
55000011 The file option is not valid or not supported.
55000014 The file was not found.
55000016 Unable to close the file.
Remarks:
Please see p3_express_import_exit (p. 13) in the PCL Reference Manual Examples.
34 PCL Reference Manual
File Menu
Description:
This function writes an optional file that is used as an input to the p3_express_import() and
p3_express_import_preview() functions.
Input:
STRING option_file[] This value specifies the name of the express
options file to be created.
LOGICAL versioning This value, when set to TRUE, specifies the
use of a version number to be used with the
express options file being created.
INTEGER file_format This value sets the file format to be used in
writing the file and can have the following
values: 1 for ascii files, 2 for compressed ascii
with no white space characters, and 3 for
binary files.
INTEGER action This value specifies the type of operation that
this options file will be used with. Currently,
only the input file operation is supported.
This argument can have the following values:
1 import file, 2 export file, 3 import
modifications, and 4 export modifications.
INTEGER source This value specifies the source of the
geometry entities. This argument can have
values that are defined in the header file
geometry_coos.i as the following symbols:
MCDONNEL_DOUGLAS or 101254,
DASSAULT_SYSTEMS or 40686,
PARAMETRIC_TECHNOLOGY or 22058,
MATRA or 32465, COMPUTER_VISION
or 22085, PDA_ENGINEERING or 52054.
LOGICAL transform_exists This value, when set to TRUE, indicates that
a transformation matrix is available in the
input value transformation and is to be written
to the options file.
Chapter 2: Basic Functions 35
File Menu
/*
* Build the transformation
matrix based on the scale *
factor
*/
FOR ( i = 1 TO 12 )
tmat(i) = 0.0
END FOR
Output:
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
55000001 Unable to allocate memory.
55000006 The handle accessed is not a file handle.
55000011 Error(s) occurred which may be resolved by using a more refined tolerance.
55000014 The file was not found.
55000016 Unable to close the file.
55000022 Not a valid entity. Either the name is not correct or it is not supported.
Remarks:
Each entry in the input value group_colors array input can have the following values:
Example:
Please see p3_express_options_file (p. 14) in the PCL Reference Manual Examples.
38 PCL Reference Manual
File Menu
Description:
This function passes information from a Unigraphics parts file to the Unigraphics server through the
use of a transmit file.
Input:
STRING ug_file_name[] This value specifies the name of the Unigraphics
part file.
LOGICAL save_switch This value, when set to TRUE, will cause a copy of
the file used to transmit information to the
Unigraphics server to be saved. When this value is
set to FALSE, the transmit file will not be saved.
LOGICAL sew_switch This value, when set to TRUE, will allow sewing
to take place. When this value is set to FALSE,
sewing will not take place.
INTEGER filter[] This value is used to specify which information
from each entity that will be passed to the
Unigraphics server. Offset 0 of this array is used to
specify the number of entities. The array should be
declared to have the (number of entities + 1)
number of offsets. When a value in an offset is set
to 0 the wire, sheet, and solid bodies information
will be used. Specific entity type information can
be used by setting the array to the values listed
below.
Output:
INTEGER number_of_components This value returns the number of components in
the Unigraphics parts file.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
None.
Remarks:
The types of entities used from the parts file can be specified by setting offsets in the input value filter to
the following values:
Chapter 2: Basic Functions 39
File Menu
Bilinear_Coons_Surface 1011
IGES_Offset_Surface 1012
PTC_plane 1013
PTC_cylinder 1014
PTC_cone 1015
PTC_torus 1016
PTC_fillet_surface 1017
PTC_generalized_Coons_surface 1018
PTC_cylindrical_spline_surface 1019
CATIA_Surface 1020
COMPUTER_VISION_Surface 1021
PieceWise_Rational_Polynomial_Surface 1022
Fence_Surface 1023
Surface_on_Solid 1024
Curve_Interpolating_Surface 1025
Extruded_Surface 1026
Glide_Surface 1027
Sweep_Normal_Surface 1028
MDC_V9Surface 1029
Composite_Trim_Surface 1030
Surface_Id_Reference 1031
PTC_sphere 1032
MDC_Sculptured_Surface 1033
Ordinary_Composite_Trim_Surface 1034
MDC_Parent_Surface 1035
TESSELLATED_SURFACE 1036
PDA_hpat 2001
Ordinary_Body 2002 General Brep Body with no
parameterization.
Tri_Linear_Solid 2003
Surface_Interpolating_Solid 2004
Solid_Of_Revolution 2005
Solid_6face 2006
Extruded_Solid 2007
Chapter 2: Basic Functions 41
File Menu
Glide_Solid 2008
Sweep_Normal_Solid 2009
Extruded_Body 2010 2 1/2 D Brep Body with no
parameterization.
Ordinary_Volume 2011 Pseudo-brep, has no
parameterization and ambiguous
topology.
Solid_Id_Reference 2012
TricubicNet 2013 Hyperpatch network.
SEW_SHEETS_BY_LAYER 52937
Example:
None
42 PCL Reference Manual
File Menu
Description:
This function passes information from a Unigraphics parts file to the Unigraphics server through the
use of a transmit file.
Input:
STRING ug_file_name[] This value specifies the name of the Unigraphics
part file.
LOGICAL import_option_flags[] This value is used to specify which import options
are ON. Offset 0 of this array is used to specify the
number of options that are on. If using the default
values, the number will be 0. The array should be
declared to have the (number of options + 1)
number of offsets. The possible offset values are
as follows:
=1; Attributes
=2; 2
=6n+1; Components
Error Conditions:
Remarks:
The types of entities used from the parts file can be specified by setting offsets in the input value
entity_filter to the following values:
Example:
None.
p3_ps_preload_part (ug_file_name)
Description:
This function calls the P3-UG Server to load the Unigraphics Part into UG/OPEN. .
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file name. This value
must include the full path.
Output:
INTEGER <Return Value> This function returns a value of 1 if the Unigraphics Part is a piece
part and a value of 2 when the Unigraphics Part is an assembly
model.
Error Conditions:
Example:
None
Description:
This function will list the name and object attributes in a Unigraphics part based on the name filter and
object filter specified.
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file name.
This value must include the full path.
STRING name_filter[] The string specifying the filter to use to list the
Unigraphics name attributes in a part.
STRING object_filter[] The string specifying the filter to use to list the
Unigraphics object attributes in a part.
Output:
INTEGER attr_count The number of name and object attributes in the
specified Unigraphics part.
STRING attributes[][] The names of the name and object attributes in the
specified Unigraphics part.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
Example:
None
Description:
This function imports parasolid transmit file models.
Input:
STRING xmt_file_name[512] This value specifies the name of the transmit file.
46 PCL Reference Manual
File Menu
STRING part_file_name[512] his value specifies the Unigraphics part file name.
This value must include the full path and may be set
to nothing or .
STRING express_file_name[] This value specifies the express options file name.
This value may be set to nothing or .
LOGICAL import_switch This value specifies, when set to TRUE, that the
transmit file should be imported. When this value is
set to FALSE the transmit file will be previewed.
INTEGER sew_edges This value specifies sewing, verification, and
cleanup options. The option values can be anded
together to specify more than one option. The
following option values are allowed: 2 to sew Patran
edges, 4 to verify edges, 8 to remove degenerate
faces, 16 to comvert trimmed to untrimmed
surfaces, 32 to equivelance edge vertices.
Output:
INTEGER ug_count[5] This value returns counts for the following items:
offset 0, minimal or vertex bodies; offset 1, wire
bodies; offset 2, sheet bodies; offset 3, b-rep bodies;
offset 4, general bodies.
INTEGER patran_count[4] This value returns the number of: offset 0, points;
offset 1, curves; offset 2, surfaces; offset 3, solids;
created by the import process.
REAL tolerance[2] This value returns the suggested model tolerance for
modeling and meshing operations in offset 0 and the
graphics tolerance in offset 1.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
21010002 Unigraphics reports error opening file%A%. Check part file, Path name, Version
number and check run-time environment variables and/or support files.
21010007 A Unigraphics memory allocation error occurred. Unable to allocate memory.
21010009 An error occurred while closing the model. Filename =%A%.
21010035
Unigraphics database%A% already referenced. Open a new Patran database to
access another part.
Chapter 2: Basic Functions 47
File Menu
Example:
None
Description:
This function imports parasolid transmit file models.
Input:
STRING xmt_file_name[512] This value specifies the name of the transmit file.
STRING part_file_name[512] his value specifies the Unigraphics part file name.
This value must include the full path and may be set
to nothing or .
STRING express_file_name[] This value specifies the express options file name.
This value may be set to nothing or .
LOGICAL import_switch This value specifies, when set to TRUE, that the
transmit file should be imported. When this value is
set to FALSE the transmit file will be previewed.
INTEGER sew_edges This value specifies sewing, verification, and
cleanup options. The option values can be anded
together to specify more than one option. The
following option values are allowed: 2 to sew Patran
edges, 4 to verify edges, 8 to remove degenerate
faces, 16 to comvert trimmed to untrimmed
surfaces, 32 to equivelance edge vertices.
Output:
INTEGER ug_count[5] This value returns counts for the following items:
offset 0, minimal or vertex bodies; offset 1, wire
bodies; offset 2, sheet bodies; offset 3, b-rep bodies;
offset 4, general bodies.
INTEGER patran_count[4] This value returns the number of: offset 0, points;
offset 1, curves; offset 2, surfaces; offset 3, solids;
created by the import process.
INTEGER n_layers This value returns the number of layers used in
system that generated the parasolid transmit file.
INTEGER layer_ids[5][256] This value returns the layer ids used in the system
that generated the parasolid transmit file.
48 PCL Reference Manual
File Menu
REAL tolerance[2] This value returns the suggested model tolerance for
modeling and meshing operations in offset 0 and the
graphics tolerance in offset 1.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
21010002 Unigraphics reports error opening file%A%. Check part file, Path name, Version
number and check run-time environment variables and/or support files.
21010007 A Unigraphics memory allocation error occurred. Unable to allocate memory.
21010009 An error occurred while closing the model. Filename =%A%.
21010035
Unigraphics database%A% already referenced. Open a new Patran database to
access another part.
Example:
None.
Chapter 2: Basic Functions 49
File Menu
Description:
This function previews the contents of parasolid transmit file models.
Input:
STRING xmt_file_name[512] This value specifies the name of the transmit file.
Output:
INTEGER ug_count[5] This value returns counts for the following items:
offset 0, minimal or vertex bodies; offset 1, wire
bodies; offset 2, sheet bodies; offset 3, b-rep
bodies; offset 4, general bodies.
INTEGER n_layers This value returns the number of layers used in
system that generated the parasolid transmit file.
INTEGER layer_ids This value returns the layer idsused in system that
generated the parasolid transmit file
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
Example:
None.
50 PCL Reference Manual
File Menu
Description:
This function will list the names of the Assembly occurrences in a Unigraphics part.
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file name.
This value must include the full path.
Output:
INTEGER occ_count The number of Assembly occurrences in the
specified Unigraphics part.
STRING occurrences[][] The names of the Assembly occurrences in the
specified Unigraphics part.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
Example:
None
Description:
This function calls the P3-UG Server to get the Unigraphics features.
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file
name. This value must include the full path.
Output:
STRING feature_names[256] (VIRTUAL) The names of features
INTEGER suppress_flag (VIRTUAL) The state of the features, whether they are
suppressed or unsuppressed.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
Chapter 2: Basic Functions 51
File Menu
Example:
None
Description:
This function calls the P3-UG Server to get the Unigraphics features that have parameters.
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file
name. This value must include the full path.
Output:
STRING feature_names[256] (VIRTUAL) The names of features that have parameters
INTEGER suppress_flag (VIRTUAL) The state of the features, whether they are
suppressed or unsuppressed.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
Example:
None.
Description:
This function calls the P3-UG Server to get the number of Unigraphics features in a part.
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file
name. This value must include the full path.
Output:
INTEGER num_features The number of features in a part.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
None.
52 PCL Reference Manual
File Menu
Example:
None.
Description:
This function calls the P3-UG Server to get the number of Unigraphics features that have parameters.
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file name.
This value must include the full path.
Output:
INTEGER num_features The number of features that have parameters
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
None.
Example:
None
pfk_get_versioned_file_name (ug_file_name)
Description:
This function calls the P3-UG Server to get the name of the Unigraphics Part that is a copy of the
original part imported into Patran.
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file name.
This value must include the full path.
Output:
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
Example:
None.
Chapter 2: Basic Functions 53
File Menu
Description:
Example:
None
Description:
This function creates a Unigraphics Import Object. It is called in conjunction with
p3_ps_open_ug_v2 and p3_ug_xmt_import_v1.
Input:
STRING ug_file_name[] This value specifies the name of the
Unigraphics
part file.
54 PCL Reference Manual
File Menu
=1; Attributes
=2; 2
=6n+1; Components
/*
* Build the
transformation matrix
based on
the scale * factor
*/
FOR ( i = 1 TO
12 )
tmat(i) =
0.0
END FOR
IF(
scale_factor > 0.0 )
THEN
use_tmat =
TRUE
tmat(1) =
scale_factor
tmat(5) =
scale_factor
tmat(9) =
scale_factor
END IF
INTEGER number_of_groups This value specifies the number of
groups to be created in the options file.
STRING group_names[number_of_groups]() This value specifies an array of group
names that will whose entities will be
read from the express neutral file.
INTEGER group_entities(number_of_groups)(64) This value specifies the entities to be
read in for each group from the express
neutral file. Initialize all unused entries
to 0. If the first entry is 0, then it is
assumed that all entities are desired.
58 PCL Reference Manual
File Menu
Example:
None.
60 PCL Reference Manual
File Menu
Description:
This function calls the P3-UG Server to check if the Unigraphics Part if it is already imported into the
Patran database.
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file name.
This value must include the full path.
LOGICAL is_imported
=TRUE if part is already imported into Patran.
Example:
None.
pfk_modify_feature_part_name (ug_file_name)
Description:
This function stores the name of the Unigraphics Part that is a copy of the original part imported into
Patran to the Patran database. This is used when the location of the copied part has been changed.
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file
name. This value must include the full path.
Output:
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
None
Chapter 2: Basic Functions 61
File Menu
Example:
None
pfk_reimport (ug_file_name)
Description:
This function calls the P3-UG Server to re-import the Unigraphics Part if it is already imported into
the Patran database.
Input:
STRING ug_file_name[512] This value specifies the Unigraphics part file
name. This value must include the full path.
Output:
INTEGER <Return Value> This function returns a value of 0 if the
Unigraphics Part successfully re-imports.
Error Conditions:
21010035
Unigraphics database%A% already referenced. Open a new Patran database to
access another part.
Example:
None
Description:
This function calls the P3-UG Server to suppress the Unigraphics features.
Input:
INTEGER num_features The number of features to suppress.
STRING feature_names[] The names of the features to suppress.
Output:
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
Example:
None.
62 PCL Reference Manual
File Menu
Description:
This function calls the P3-UG Server to unsuppress the Unigraphics features.
Input:
INTEGER num_features The number of features to unsuppress.
STRING feature_names[] The names of the features to unsuppress.
Output:
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
Example:
None
pfk_update ()
Description:
This function calls the P3-UG Server to regenerate the Unigraphics model with the latest feature
editing changes and updates the Patran model accordingly.
Input:
Output:
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
21010303 Regeneration failed because cannot re-open the part.
Example:
None
Chapter 2: Basic Functions 63
File Menu
Description:
This function will retrieve integer values of a Parasolid integer attribute that is attached to a Patran
entity. The attribute definition must be identified by the input identifier. The Patran id and entity
type are used to lookup the associated Parasolid attribute definition.
Input:
INTEGER p3id
The Patran id of the entity used to look up the associated
Parasolid attribute definition.
INTEGER p3type
The Patran entity type. Valid entity type values are:
1 for a point,
2 for a curve,
3 for a surface, and
4 for a solid
STRING identifier The string by which the attribute definition is identified.
INTEGER field_no The index to the location of the string field of the
attribute definition.
Output:
INTEGER n_values The number of integer attribute values.
REAL attribute_values[] The Parasolid integer attribute values.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
1 Out of memory.
4 Parasolid tag not found
7 The specified attribute does not exist.
8 The Parasolid attribute class does not exist.
9 The Parasolid attribute definition was not found.
11 Non-printing characters in name.
255 Invalid string length.
257 Cant reallocate virtual string array
259 Not a virtual string.
5013 The attribute does not have a field with this number.
5014 The field is not a string field.
64 PCL Reference Manual
File Menu
Note: The value for field_no will be 0 for most if not all attributes.
Chapter 2: Basic Functions 65
File Menu
Description:
This function will retrieve real values of a Parasolid real attribute that is attached to a Patran entity. The
attribute definition must be identified by the input identifier. The Patran id and entity type are used
to lookup the associated Parasolid attribute definition.
Input:
INTEGER p3id
The Patran id of the entity used to look up the
associated Parasolid attribute definition.
INTEGER p3type
The Patran entity type. Valid entity type values are:
1 for a point,
2 for a curve,
4 for a solid
STRING identifier The string by which the attribute definition is
identified.
INTEGER field_no The index to the location of the string field of the
attribute definition.
Output:
INTEGER n_values The number of real attribute values.
REAL attribute_values[] The Parasolid real attribute values.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
1 Out of memory.
4 Parasolid tag not found
7 The specified attribute does not exist.
8 The Parasolid attribute class does not exist.
9 The Parasolid attribute definition was not found.
11 Non-printing characters in name.
255 Invalid string length.
257 Cant reallocate virtual string array
66 PCL Reference Manual
File Menu
Note: The value for field_no will be 0 for most if not all attributes.
Description:
This function will retrieve a Parasolid string attribute that is attached to a Patran entity. The attribute
definition must be identified by the input identifier and attached to a Parasolid entity at the body
layer. The Patran ID and entity type are used to lookup the associated Parasolid attribute definition.
1 for a point,
2 for a curve,
4 for a solid.
STRING identifier The string by which the attribute definition is identified.
INTEGER field_no The index to the location of the string field of the attribute
definition.
Output:
Chapter 2: Basic Functions 67
File Menu
Example:
Description:
This function will retrieve a Parasolid string attribute that is attached to a Patran entity. The attribute
definition must be identified by the input identifier and attached to a Parasolid Entity at the topology
layer. The Patran id and entity type are used to lookup the associated Parasolid attribute definition.
Input:
INTEGER p3id
The Patran id of the entity used to look up the associated
Parasolid id.
68 PCL Reference Manual
File Menu
INTEGER p3type
The Patran entity type. Valid entity type values are:
1 for a point,
2 for a curve,
4 for a solid.
STRING classname The Parasolid attribute class.
( See Parasolid Reference Manual for more information. )
INTEGER field The Parasolid attribute field.
( See Parasolid Reference Manual for more information. )
Output:
STRING attribute The Parasolid string attribute.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
1 Out of memory
4 Parasolid tag not found
7 The specified attribute does not exist
8 The Parasolid attribute class does not exist. -
(see parasolid_kernel.h.)
5014 The field is not a string field - (see parasolid_kernel.h.)
13000211 Virtual memory has been exhausted.
13000212 There is an error interacting with the PERSISTENT_MEMORY relation in the
database.
Chapter 2: Basic Functions 69
File Menu
Example:
select_focus.exit ()
Description:
This function will hide the currently displayed select menu, clear the current filter, and reset the
currently selected data box.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None
Example:
Please see select_focus.exit (p. 23) in the PCL Reference Manual Examples.
70 PCL Reference Manual
File Menu
Description:
This function is used to import a Unigraphics part file defining the geometry of a model.
Input:
STRING file_name[] This value specifies the name of the path and the file
to be imported.
INTEGER file_name_length This value specifies the number of characters in the
file_name input value.
STRING group_name[80] This value specifies the name of the group to which
the imported geometry will be added.
INTEGER group_name_length This value specifies the number of characters in the
group_name input value.
LOGICAL entity_toggle_values(18) This value specifies an array used to select the
geometry entity types to be imported where the
offset into the array defines the entity type. The
value at that offset will be set TRUE if that entity
type is to be imported. See the remarks below for
more information.
LOGICAL simply_trimmed This value, when set TRUE, causes all surfaces to be
imported as simple trimmed surfaces and when set
FALSE all surfaces are imported as general trimmed
surfaces.
LOGICAL access_as_solids This value, when set to TRUE, allows all imported
geometric entities are to be accessed as solids. Set
this value to FALSE if the imported geometric
entities define constituent surfaces.
LOGICAL enable_tol_prompt This value, when set to TRUE, enables the user to be
prompted for the global model tolerance. When this
value is set to FALSE, the currently defined global
model tolerance is used.
Chapter 2: Basic Functions 71
File Menu
LOGICAL color_toggle_values(14) This value specifies the overall color filter values.
Currently, these values are ignored.
LOGICAL all_layers Set this value to TRUE if all entities identified by the
input value entity_toggle_values from all layers
should be imported.
LOGICAL active_layer This value should be set to TRUE if only the active
or work layer entities will be imported.
INTEGER layer_numbers(256) This value specifies an input value that contains the
layer values entered by the user from which entities
will be imported.
STRING model_type[6] This value specifies the CAD model type and should
always be set to ug.
INTEGER number_of_groups This value specifies the number of groups defined.
This input has a maximum value of 256.
INTEGER group_entity_ids(number_of This value specifies an array that specifies the ID
_groups) values used for each entity group.
LOGICAL group_entity_values(number This value specifies a two dimensional array that
_of_groups, 20) contains values set to TRUE if an entity is to be
included and FALSE if an entity is not to be included
in the group being imported. The offset in the first
dimension corresponds to the group id in the same
offset of the group_entity_ids input value. The offset
in the second dimension of the array identifies the
entity type. See the remarks below for more
information.
LOGICAL group_color_values(number This value specifies a two dimensional array that
_of_groups, 14) contains values set to TRUE if a color value is to be
used. The offset in the first dimension corresponds to
the group id in the same offset of the
group_entity_ids input value. The offset in the
second dimension of the array identifies the color
type. Currently this input value is ignored.
LOGICAL active_layer_values(number This value specifies an array where the value at an
_of_groups) offset corresponding to the offset for the group id in
the group_entity_values input value to is set to
TRUE if an entity in the active layer is included in
the group identified by the offset into this array.
72 PCL Reference Manual
File Menu
INTEGER layer_pointers(number_of_gr This value specifies an array where the offset into
oups) the array corresponds with the offset into the
group_entity_ids array that lists the group ids. The
value at that offset in this array identifies the offset
into the group_layers array where the number of
layer values for each group is stored. This array can
store values that range from 1 to (512 -
number_of_groups).
INTEGER group_layers(512) This value specifies an array that contains values
used to identify the number of layers imported for
each group.
Output:
INTEGER ug_count(256, 37) This value specifies a two dimensional array that
uses the first dimension to identify a layer. The
second dimension is used to identify a particular
entity type. The cell value indicates the number of
entities of a particular entity type present on a
particular layer.
INTEGER patran_count(4) This value indicates the number of entities that were
successfully imported. See the remarks below for
more information.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
21010002 Unigraphics reports error opening file%A%. Check part file, Path name, Version
number and check run-time environment variables and/or support files.
21010007 A Unigraphics memory allocation error occurred. Unable to allocate memory.
21010009 An error occurred while closing the model. Filename =%A%.
21010035
Unigraphics database%A% already referenced. Open a new Patran database to
access another part.
Remarks:
The input value entity_toggle_values and the second dimension of the two dimensional input value
group_entity_values are used to select the geometry entities to be imported where the offset into the array
indicates the geometry type to be imported when set TRUE as follows:
Chapter 2: Basic Functions 73
File Menu
The output value patran_count is used to count several different types of operations:
Offset Count
Type
1 Not used. Should always be set to the initial value assigned to that offset.
2 Counts the number of ordinary trimmed surfaces.
3 Counts the number of: MDC Surfaces, IGES trimmed surfaces, Composite
trimmed surfaces.
4 Number of entities written to the database.
This function can display a fatal popup form if the following errors occur:
21010002 Unigraphics reports error opening file%A%. Check part file, Path name, Version
number and check run-time environment variables and/or support files.
21010007 A Unigraphics memory allocation error occurred. Unable to allocate memory.
21010009 An error occurred while closing the model. Filename =%A%.
This function can display an information popup form with the following messages:
This function will display a popup form that will provide a summary of the number of entities accessed
from the Unigraphics part file.
This function can display a popup form used to prompt the user for information about the global model
tolerance.
This function can display a warning popup message with the following text:
21010060 Missing one or more environment variables. The following MUST be set
according to guidelines given in installation notes: OPENWINHOME (SUN4
ONLY), LD_LIBRARY_PATH(SUN4 ONLY), UGII_ROOT_DIR,
UGII_FILE_SYSTEM, UGII_BASE_DIR, UGII_USERFCN,
UGII_UGSOLIDS, UGII_SCHEMA, UGII_TERMMOD, UGII_06_FILE,
UGII_10_FILE, UGII_CAM, UGII_UGCNCPT.
Example:
Please see sgm_cad_access_v1 (p. 24) in the PCL Reference Manual Examples.
Description:
This function is used to import a CATIA model geometry file but has no control over the model
tolerance.
Input:
STRING file_name[] This value specifies the name of the path and the
file to be imported.
STRING group_name[80] This value specifies the name of the group to
which the imported geometry will be added.
Currently, this value is ignored.
INTEGER group_name_length This value specifies the number of characters in
the group_name input value. Currently, this
value is ignored.
Chapter 2: Basic Functions 75
File Menu
Remarks:
This function does not provide any user input controls for the global model tolerance. Importing a
CATIA model geometry file with control over the model tolerance can be done through the use of the
function sgm_catia_access_v1.
This function will provide an information display listing the percentage of each entity type being read
into Patran from the CATIA model geometry file. The geometry read from the CATIA model geometry
file will be entered into the Patran database and be shown on the display.
Example:
Please see sgm_catia_access (p. 26) in the PCL Reference Manual Examples.
Description:
This function is used to import a CATIA model geometry file while providing the user with control
over the model tolerance.
Input:
STRING file_name[] This value specifies the name of the path and the
file to be imported.
STRING group_name[80] This value specifies the name of the group to which
the imported geometry will be added. Currently,
this value is ignored.
78 PCL Reference Manual
File Menu
Remarks:
This function, sgm_catia_access_v1(), differs from the sgm_catia_access() function by providing the
input value enable_tol_prompt to allow the user to have some control over the model tolerance used when
the geometry file is imported.
This function will provide an information display listing the percentage of each entity type being read
into Patran from the CATIA model geometry file. The geometry read from the CATIA model geometry
file will be entered into the Patran database and be shown in the current viewport.
Example:
Please see sgm_catia_access_v1 (p. 28) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 81
File Menu
Description:
This function will import CATXPRES catia geometry objects.
Input:
STRING file_name[] This value specifies the name of the CATXPRES file
to import.
LOGICAL simple_trim This value specifies, when set to TRUE, that the
Catia surfaces will be converted to Patran simple
trimmed surfaces. When set to FALSE, the Catia
surfaces will be converted to Patran general trimmed
surfaces.
INTEGER solid_Type This value specifes, when set to 1 that all solids will
be converted to Patran brep solids. When this value
Remarks:
None
Example:
None
82 PCL Reference Manual
File Menu
Description:
This function is used to import a EUCLID model geometry file but has no control over the model
tolerance.
Input:
STRING file_name[] This value specifies the name of the path and the file
to be imported.
STRING group_name[80] This value specifies the name of the group to which
the imported geometry will be added. Currently, this
value is ignored.
INTEGER group_name_length This value specifies the number of characters in the
group_name input value. Currently, this value is
ignored.
LOGICAL entity_toggle_values(18) This value specifies an array used to select the
geometry entity types to be imported where the
offset into the array defines the entity type. The
value at that offset will be set TRUE if that entity
type is to be imported. Currently, these values are
ignored.
LOGICAL simply_trimmed This value should be set to TRUE to import all
surfaces as simple trimmed surfaces or to FALSE to
import all surfaces as general trimmed surfaces.
Currently, this value is ignored.
LOGICAL color_toggle_values(14) This value specifies an array that is used to set the
overall color filter values. Currently, these values are
ignored.
LOGICAL all_layers This value should be set to TRUE if all entities
identified by the input value entity_toggle_values
from all layers should be imported. Currently, this
value is ignored.
Chapter 2: Basic Functions 83
File Menu
LOGICAL active_layer This value should be set to TRUE if only the active
or work layer entities will be imported. Currently,
this value is ignored.
INTEGER layer_numbers(256) This value specifies an array that is used to set the
layer values entered by the user for the overall layer
filter. Currently, this value is ignored.
STRING model_type[6] This value specifies the CAD model type and should
always be set to euclid.
INTEGER number_of_groups This value specifies the number of groups defined.
This input has a maximum value of 256. Currently,
this value is ignored.
INTEGER group_entity_ids(number_of_gro This value specifies an array that is used to set the ID
ups) values for each user group. Currently, this value is
ignored.
LOGICAL group_entity_values(number_of_ This value specifies a two dimensional array that
groups, 20) contains values set to TRUE if an entity is to be
included and FALSE if an entity is not to be included
in the group being imported. The offset in the first
dimension corresponds to the group id in the same
offset of the group_entity_ids input value. The offset
in the second dimension of the array identifies the
entity type. Currently, these values are ignored.
LOGICAL group_color_values(number_of_ This value specifies a two dimensional array that
groups, 14) contains values set to TRUE if a color value is to be
used. The offset in the first dimension of this array
corresponds to the group id in the same offset of the
group_entity_ids input value. The offset in the
second dimension of this array identifies the color
type. Currently, these values are ignored.
LOGICAL active_layer_values(number_of_ This value specifies an array that is used by setting
groups) the value at an offset that corresponds to the offset
for the group id in the group_entity_values input
value to TRUE if an entity in the active layer is
included in the group identified by the offset into the
array. Currently, these values are ignored.
84 PCL Reference Manual
File Menu
Remarks:
This function does not provide any user input controls for the global model tolerance. Importing a
EUCLID model geometry file with control over the model tolerance can be done through the use of the
sgm_euclid_access_v1 function.
This function will provide an information display listing the percentage of each entity type being read
into Patran from the EUCLID model geometry file. The geometry read from the EUCLID model
geometry file will be entered into the Patran database and be shown on the display.
Chapter 2: Basic Functions 85
File Menu
Example:
Please see sgm_euclid_access (p. 30) in the PCL Reference Manual Examples.
Description:
This function is used to import a EUCLID model geometry file while providing the user with control
over the model tolerance.
Input:
STRING file_name[] This value specifies the name of the path and the file
to be imported.
STRING group_name[80] This value specifies the name of the group to which
the imported geometry will be added. Currently, this
value is ignored.
INTEGER group_name_length This value specifies the number of characters in the
group_name input value. Currently, this value is
ignored.
LOGICAL entity_toggle_values(18) This value specifies an array used to select the
geometry entity types to be imported where the offset
into the array defines the entity type. The value at that
offset will be set TRUE if that entity type is to be
imported. Currently, these values are ignored.
LOGICAL simply_trimmed This value should be set to TRUE to import all
surfaces as simple trimmed surfaces or to FALSE to
import all surfaces as general trimmed surfaces.
Currently, this value is ignored.
LOGICAL enable_tol_prompt This value should be set to TRUE to enable
prompting from the user for the global model
tolerance or to FALSE to use the currently defined
global model tolerance.
86 PCL Reference Manual
File Menu
LOGICAL color_toggle_values(14) This value specifies an array that is used to set the
overall color filter values. Currently, these values are
ignored.
LOGICAL all_layers This value should be set to TRUE if all entities
identified by the input value entity_toggle_values
from all layers should be imported. Currently, this
value is ignored.
LOGICAL active_layer This value should be set to TRUE if only the active
or work layer entities will be imported. Currently,
this value is ignored.
INTEGER layer_numbers(256) This value specifies an array that is used to set the
layer values entered by the user for the overall layer
filter. Currently, this value is ignored.
STRING model_type[6] This value specifies the CAD model type and should
always be set to euclid.
INTEGER number_of_groups This value specifies the number of groups. This
input value has a maximum value of 256. Currently,
this value is ignored.
INTEGER group_entity_ids(number_ This array specifies the ID values for each user
of_groups) group. Currently, this value is ignored.
LOGICAL group_entity_values(numb This value specifies a two dimensional array that
er_of_groups, 20) contains values set to TRUE if an entity is to be
included and FALSE if an entity is not to be included
in the group being imported. The offset in the first
dimension corresponds to the group id in the same
offset of the group_entity_ids input value. The offset
in the second dimension of the array identifies the
entity type. Currently, these values are ignored.
LOGICAL group_color_values(numbe This value specifies a two dimensional array that
r_of_groups, 14) contains values set to TRUE if a color value is to be
used. The offset in the first dimension of this array
corresponds to the group id in the same offset of the
group_entity_ids input value. The offset in the
second dimension of this array identifies the color
type. Currently, these values are ignored.
LOGICAL active_layer_values(numbe This value specifies an array that is used by setting
r_of_groups) the value at an offset that corresponds to the offset for
the group id in the group_entity_values input value to
TRUE if an entity in the active layer is included in the
group identified by the offset into the array.
Currently, these values are ignored.
Chapter 2: Basic Functions 87
File Menu
Remarks:
This function, sgm_euclid_access_v1(), differs from the sgm_euclid_access() function by providing the
input value enable_tol_prompt to allow the user to have some control over the model tolerance used when
the geometry file is imported.
88 PCL Reference Manual
File Menu
This function will provide an information display listing the percentage of each entity type being read
into Patran from the EUCLID model geometry file. The geometry read from the EUCLID model
geometry file will be entered into the Patran database and be shown in the current viewport.
Example:
Please see sgm_euclid_access_v1 (p. 31) in the PCL Reference Manual Examples.
Description:
This function is used to import a Pro/ENGINEER model geometry file.
Input:
STRING file_name[] This value specifies the name of the path and the file
to be imported.
STRING file_type[3] This value specifies the geometry file type and can
have the following case insensitive values: PRT,
ASM, and GEO.
LOGICAL simply_trimmed This value should be set to TRUE to import all
surfaces as simple trimmed surfaces or to FALSE to
import all surfaces as general trimmed surfaces.
LOGICAL create_groups
This value should be set to TRUE if Patran groups
are to be created from Pro/ENGINEER parts in an
assembly listed in the imported file.
LOGICAL save_geo_file This value should be set to TRUE if the .geo file is
to be saved after accessing the .prt or .asm file.
LOGICAL enable_tol_prompt This value should be set to TRUE to enable
prompting from the user for the global model
tolerance or to FALSE to use the currently defined
global model tolerance.
INTEGER pro_entities (17) This value specifies the Pro/ENGINEER entities to
access. See the remarks below for more information.
Output:
INTEGER pro_count(9) This value returns an array listing the counts of
Pro/ENGINEER entities that were in the imported
file versus the counts of entities that were processed.
See the remarks below for more information.
Chapter 2: Basic Functions 89
File Menu
Remarks:
The input value file_type can have the following values: PRT, ASM, GEO. This string value is not
case sensitive.
90 PCL Reference Manual
File Menu
The input value pro_entities uses offset 1 to specify the number of entities. Offsets 2 through 17 can be
set to a value that identifies the entity type:
Table 2-1
Entity type Array value
Solid Face 1
Datum Point 2
Datum Curve 3
Datum Surface 4
Plane 108
Spline Surface 114
Ruled Surface 118
Surface of Revolution 120
Tabulated Cylinder 122
B_Spline Surface 128
Cylinder 154
Cone 156
Torus 160
Coons Patch 170
Fillet Surface 172
Cylindrical Spline Surface 174
The integer output array pro_count returns values where the offsets identify the following type of entities
Table 2-2
Array offset Entity type
1 Face Count
2 Point Count
3 Curve Count
4 Surface Count
5 Number of parts
6 Number of faces Processed
7 Number of points Processed
8 Number of curves Processed
9 Number of surfaces Processed
Chapter 2: Basic Functions 91
File Menu
The integer output array patran_count returns values where the offsets identify the following type
of entities:
Table 2-3
Array offset Entity type
1 Trimmed Surface Count
2 Number of points Processed
3 Number of curves Processed
4 Number of surfaces Processed
5 The Parent Surface Count
6 Trimmed Curve Count
7 Number of groups
This function will import model geometry from the specified file, place it in the database and display it
in the current viewport.
This function can display fatal popup forms with the following messages:
This function can display informational popup forms with the following messages:
This function can display warning popup forms with the following messages:
38000828 A total of%I% surface contours were not closed in real (3D) space. The
maximum gap distance was%G%. Try setting the Global Model Tolerance in the
Global Preferences to a value greater than the gap distance and try again.
This function displays a warning popup form showing the message associated with the status value
returned by the function:
ga_group_current_set()
92 PCL Reference Manual
File Menu
Example:
Please see sgm_ptc_access_v2 (p. 35) in the PCL Reference Manual Examples.
Description:
This function is used to import a Pro/ENGINEER model geometry file.
Input:
STRING file_name[] This value specifies the name of the path and the
file to be imported.
STRING file_type[3] This value specifies the geometry file type and
can have the following case insensitive values:
PRT, ASM, and GEO.
LOGICAL simply_trimmed This value should be set to TRUE to import all
surfaces as simple trimmed surfaces or to
FALSE to import all surfaces as general
trimmed surfaces.
LOGICAL create_groups
This value should be set to TRUE if Patran
groups are to be created from Pro/ENGINEER
parts in an assembly listed in the imported file.
LOGICAL save_geo_file This value should be set to TRUE if the .geo file
is to be saved after accessing the .prt or .asm file.
LOGICAL tol_prompt_on This value should be set to TRUE to enable
prompting from the user for the global model
tolerance or to FALSE to use the currently
defined global model tolerance.
LOGICAL as_solid This value should be set to TRUE if a B-rep is to
be imported as a Solid or to FALSE if a B-rep is
to be imported as a set of constituent surfaces.
INTEGER pro_entities (19) This value specifies the Pro/ENGINEER entities
to access. See the remarks below for more
information.
Output:
Chapter 2: Basic Functions 93
File Menu
Remarks:
The input value file_type can have the following values: PRT, ASM, GEO. This string value is not
case sensitive.
The input value pro_entities uses offset 1 to specify the number of entities. Offsets 2 through 17 can be
set to a value that identifies the entity type:
94 PCL Reference Manual
File Menu
Table 2-4
Entity type Array value
Solid Face 10
Datum Point 1
Datum Curve 2
Datum Surface 4
Datum Plane 8
Coord Sys Datum 16
Plane 108
Spline Surface 114
Ruled Surface 118
Surface of Revolution 120
Tabulated Cylinder 122
B_Spline Surface 128
Cylinder 154
Cone 156
Torus 160
Coons Patch 170
Fillet Surface 172
Cylindrical Spline Surface 174
Chapter 2: Basic Functions 95
File Menu
The integer output array pro_count returns values where the offsets identify the following type of entities
Table 2-5
Array offset Entity type
1 Face count
2 Point count
3 Curve count
4 Surface count
5 Plane count
6 Coordinate System count
7 Number of parts
8 Number of faces processed
9 Number of points processed
10 Number of curves processed
11 Number of surfaces processed
12 Number of planes processed
13 Number of coordinate systems
processed
The integer output array patran_count returns values where the offsets identify the following type
:
of entities:
Table 2-6
Array offset Entity type
1 Trimmed Surface count
2 Number of points processed
3 Number of curves processed
4 Number of surfaces processed
5 The Solid count
6 Number of planes processed
7 Number of coordinate systems processed
8 The Parent Surface count
9 Trimmed Curve count
10 Number of groups
96 PCL Reference Manual
File Menu
This function will import model geometry from the specified file, place it in the database and display it
in the current viewport.
This function can display fatal popup forms with the following messages:
This function can display informational popup forms with the following messages:
This function can display warning popup forms with the following messages:
38000828 A total of%I% surface contours were not closed in real (3D) space. The
maximum gap distance was%G%. Try setting the Global Model Tolerance in
the Global Preferences to a value greater than the gap distance and try again.
This function displays a warning popup form showing the message associated with the status value
returned by the function:
ga_group_current_set()
Example:
None.
Chapter 2: Basic Functions 97
File Menu
Description:
This function is used to import a Pro/ENGINEER model geometry file.
Input:
STRING file_name[] This value specifies the name of the path and the file to be
imported.
STRING file_type[3] This value specifies the geometry file type and can have the
following case insensitive values: PRT, ASM, and
GEO.
LOGICAL simply_trimmed This value should be set to TRUE to import all surfaces as
simple trimmed surfaces or to FALSE to import all surfaces
as general trimmed surfaces.
LOGICAL create_groups
This value should be set to TRUE if Patran groups are to be
created from Pro/ENGINEER parts in an assembly listed in
the imported file.
LOGICAL save_geo_file This value should be set to TRUE if the .geo file is to be
saved after accessing the .prt or .asm file.
LOGICAL tol_prompt_on This value should be set to TRUE to enable prompting from
the user for the global model tolerance or to FALSE to use
the currently defined global model tolerance.
LOGICAL as_solid This value should be set to TRUE if a B-rep is to be imported
as a Solid or to FALSE if a B-rep is to be imported as a set
of constituent surfaces.
INTEGER pro_entities (20) This value specifies the Pro/ENGINEER entities to access.
See the remarks below for more information.
Output:
INTEGER pro_count(15) This value returns an array listing the counts of
Pro/ENGINEER entities that were in the imported file
versus the counts of entities that were processed. See the
remarks below for more information.
INTEGER patran_count(11)
This value returns an array listing the number of Patran
entities created. See the remarks below for more
information.
98 PCL Reference Manual
File Menu
Remarks:
The input value file_type can have the following values: PRT, ASM, GEO. This string value is not
case sensitive.
Chapter 2: Basic Functions 99
File Menu
The input value pro_entities uses offset 1 to specify the number of entities. Offsets 2 through 17 can be
set to a value that identifies the entity type:
Table 2-7
Entity type Array value
Solid Face 10
Datum Point 1
Datum Curve 2
Datum Surface 4
Datum Plane 8
Coord Sys Datum 16
Material 32
Plane 108
Spline Surface 114
Ruled Surface 118
Surface of Revolution 120
Tabulated Cylinder 122
B_Spline Surface 128
Cylinder 154
Cone 156
Torus 160
Coons Patch 170
Fillet Surface 172
Cylindrical Spline Surface 174
The integer output array pro_count returns values where the offsets identify the following type of entities
Table 2-8
Array offset Entity type
1 Face count
2 Point count
3 Curve count
4 Surface count
5 Plane count
6 Coordinate System count
7 Material count
100 PCL Reference Manual
File Menu
Table 2-8
Array offset Entity type
8 Number of parts
9 Number of faces processed
10 Number of points processed
11 Number of curves processed
12 Number of surfaces processed
13 Number of planes processed
14 Number of coordinate systems processed
15 Number of materials processed
The integer output array patran_count returns values where the offsets identify the following type
of entities:
Table 2-9
Array offset Entity type
1 Trimmed Surface count
2 Number of points processed
3 Number of curves processed
4 Number of surfaces processed
5 The Solid count
6 Number of planes processed
7 Number of coordinate systems processed
8 The Parent Surface count
9 Trimmed Curve count
10 Number of groups
11 Number of materials processed
This function will import model geometry from the specified file, place it in the database and display it
in the current viewport.
This function can display fatal popup forms with the following messages:
Chapter 2: Basic Functions 101
File Menu
This function can display informational popup forms with the following messages:
This function can display warning popup forms with the following messages:
38000828 A total of%I% surface contours were not closed in real (3D) space. The
maximum gap distance was%G%. Try setting the Global Model Tolerance
in the Global Preferences to a value greater than the gap distance and try
again.
38000847 The Material assigned to part %A% in Pro/ENGINEER was not written to
the Patran database because a solid did not get created.
38000848 Error occurred ateempting to write the Material %A% assigned to aprt
%A% in Pro/ENGINEER to solid %l% in the Patran database.
This function displays a warning popup form showing the message associated with the status value
returned by the function:
ga_group_current_set()
Example:
None
102 PCL Reference Manual
File Menu
uil_db_commit (command)
Description:
This function will submit the last database transaction so that it cannot be undone and set the
description string to be used with the undone operation.
Input:
STRING command[] This value specifies a description of current command to be
used in the message when the command is undone.
Output:
None.
Error Conditions:
None.
Remarks:
The results of prior database operations are set so that only the database transactions from this point on
can be undone.
This routine should be called in the callback for the Apply button in a popup form used to control an
application or at the beginning of a logical command.
Example:
Please see uil_db_commit (p. 36) in the PCL Reference Manual Examples.
uil_db_undo ()
Description:
This function will undo the last database transaction.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
All database operations done since the last call to the uil_db_commit() function will be thrown away. The
recording session file will be updated from the point of the last call to the uil_db_commit() function.
Chapter 2: Basic Functions 103
File Menu
Example:
Please see uil_db_undo (p. 37) in the PCL Reference Manual Examples.
uil_file_close.go ()
Description:
This function will close a database.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
Executing this function will close all viewports and forms with the exception of the main form.
Example:
Please see uil_file_close.go (p. 38) in the PCL Reference Manual Examples.
Description:
This function will create and open a new database using the specified database and template file
name.
Input:
STRING template_name[256] This value specifies the name of database to be
used as the template. If this value is set to , the
P3_HOME/template.db file will be used.
STRING file_name[256] This value specifies the name of the database to be
created.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
104 PCL Reference Manual
File Menu
8111002 File%A% is in use by another user. Opening this database may cause undesirable
results. Do you wish to continue anyway?
36000001 Cannot open database%A%.A database is already open.
36000002 Database%A% already exists.Do you wish to delete the existing database and
create a new one?
Remarks:
Using this function to create databases across machine-type boundaries is not recommended.
The database files created by this function may not be compatible from machine type to machine type.
This function can display yes/no query popup forms with the messages:
8111002 File%A% is in use by another user. Opening this database may cause undesirable
results. Do you wish to continue anyway?
36000002 Database%A% already exists. Do you wish to delete the existing database and create
a new one?
This function can display a fatal popup form with the message:
This function will write comments to the journal and session files.
Example:
Please see uil_file_new.go (p. 39) in the PCL Reference Manual Examples.
uil_file_open.go (file_name)
Description:
This function will open a database.
Input:
STRING file_name[256] This value specifies the name of the database to open.
Output:
None.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8111002 File%A% is in use by another user. Opening this database may cause undesirable
results. Do you wish to continue anyway?
Chapter 2: Basic Functions 105
File Menu
Remarks:
Using this function to open a database created on a machine of a different type is not recommended.
This function can display a fatal popup form with the message:
This function can display a warning popup form with the message:
39000004 Journal file%A% does not exist. No journal file will be created.
This function can display yes/no query popup forms with the messages:
36000003 Database%A% does not exist.Do you wish to create a new database?
This function may not be able to open database files that have been transferred from one machine type
to another.
A viewport for the loaded database file will be displayed and the preferences will be set using information
from the opened database.
Example:
Please see uil_file_open.go (p. 40) in the PCL Reference Manual Examples.
106 PCL Reference Manual
File Menu
uil_imaging_coordframes.post_cf (contents)
Description:
This function will post the selected coordinate frames to all viewports.
Input:
STRING contents[] This value specifies a list of coordinate frame identifiers to post to
all viewports.
Output:
None.
Error Conditions:
None
Remarks:
This function can display a warning popup form with the message:
11005001 Global Coordinate Frame 0 (Global Axes Display) is controlled per viewport via the
Viewport Modify form.
This function can display a fatal popup form with the following messages:
This function calls and can display the status value returned by the following function in a warning
popup form.
db_post_coord()
This function calls but does not return the status values returned by the following functions:
app_get_handle()
app_next_label()
Example:
Please see uil_imaging_coordframes.post_cf (p. 40) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 107
File Menu
uil_imaging_coordframes.unpost_cf (contents)
Description:
This function will unpost the selected coordinate frames to all viewports.
Input:
STRING contents[] This value specifies a list of coordinate frame identifiers to unpost
from all viewports.
Output:
None.
Error Conditions:
None.
Remarks:
This function can display a fatal popup form with the following messages:
This function can display a warning popup form with the message:
11005001 Global Coordinate Frame 0 (Global Axes Display) is controlled per viewport via
the Viewport Modify form.
This function calls but does not return the status values returned by the following functions:
app_get_handle()
app_next_label()
Example:
Please see uil_imaging_coordframes.unpost_cf (p. 42) in the PCL Reference Manual Examples.
108 PCL Reference Manual
File Menu
uil_primary.get_menubar_id ()
Description:
This function returns the widget value for the Patran menu bar.
Input:
None.
Output:
widget <Return Value> This value returns the widget identifier for the main menu bar.
Error Conditions:
None.
Remarks:
This function can be called from or after the p3epilog.pcl start-up file has been run by the init.pcl
file. Calling it before the p3epilog.pcl file has been run may cause allow an invalid widget id to
be returned.
Example:
Please see uil_primary.get_menubar_id (p. 43) in the PCL Reference Manual Examples.
uil_viewport_tiling.tile ()
Description:
This function tiles or places in a side by side arrangement up to four posted viewports.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
This function will display a warning popup form with the following message if more than four viewports
are posted:
Chapter 2: Basic Functions 109
File Menu
This function will display a fatal popup form listing the message associated with the status returned by
the following functions:
ga_viewport_location_get()
ga_viewport_location_set()
ga_viewport_nposted_get()
ga_viewport_posted_get()
ga_viewport_size_set()
This function will return immediately if Patran is being run in batch mode.
Example:
Please see uil_viewport_tiling.tile (p. 43) in the PCL Reference Manual Examples.
Description:
This function exports Patran geometry information from the database to a file in the IGES standard
file format.
Input:
STRING file_name[] This value specifies the name of the path and the file to
be created.
STRING start_section[] This value specifies the IGES file start section prolog
lines.
STRING model_units[] This value specifies the IGES file model units.
LOGICAL entity_values(7) This value specifies the entity type filter status flags used
to specify which Patran entity types will be exported to
the IGES file.
LOGICAL all_groups This value is set to TRUE if all groups are to be exported
to the IGES file.
INTEGER number_of_groups
This value specifies the number of Patran groups to be
exported to the IGES file.
INTEGER group_entity_ids(num This value specifies an array containing the IDs of the
ber_of_groups) Patran groups to be exported to the IGES file.
110 PCL Reference Manual
File Menu
Output:
INTEGER patran_count(7)
This value returns a list of the number of Patran entities
processed from the database by type.
INTEGER iges_count(20) This value returns the number of IGES entities created
by type.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-1 This is an internal status condition. There is no corresponding status message in
the message database.
Chapter 2: Basic Functions 111
File Menu
Remarks:
This function can display information popup forms with the following messages:
This function can display fatal popup forms with the following messages:
This function can display a query popup form with the following message:
36000005 %A% File%A% already exists.Do you wish to delete the existing%A% file and
create a new one?
This function can display fatal popup forms listing the messages associated with the status values
returned by a call to the function:
file_delete()
Example:
None
112 PCL Reference Manual
File Menu
Description:
This function exports Patran geometry information from the database to a file in the IGES standard
file format.
Input:
STRING file_name[] This value specifies the name of the path and the file to
be created.
STRING start_section[] This value specifies the IGES file start section prolog
lines.
INTEGER nlpos(*) New line character (\n) positions in Start Section.
INTEGER nlknt Number of new line characters (\n) in Start Section.
STRING product_id Product Id for receiving system
STRING author Author
STRING author_org Authors Organization
STRING model_units[] This value specifies the IGES file model units.
LOGICAL entity_values(8) This value specifies the entity type filter status flags
used to specify which Patran entity types will be
exported to the IGES file.
LOGICAL all_groups This value is set to TRUE if all groups are to be
exported to the IGES file.
INTEGER number_of_groups
This value specifies the number of Patran groups to be
exported to the IGES file.
INTEGER group_entity_ids(number This value specifies an array containing the IDs of the
_of_groups)
Patran groups to be exported to the IGES file.
Output:
INTEGER patran_count(8)
This value returns a list of the number of Patran entities
processed from the database by type.
INTEGER iges_count(21) This value returns the number of IGES entities created
by type.
Chapter 2: Basic Functions 113
File Menu
Remarks:
This function can display information popup forms with the following messages:
This function can display fatal popup forms with the following messages:
This function can display a query popup form with the following message:
36000005 %A% File%A% already exists.Do you wish to delete the existing%A% file and
create a new one?
This function can display fatal popup forms listing the messages associated with the status values
returned by a call to the function:
Example:
None
114 PCL Reference Manual
File Menu
Description:
This function exports Patran geometry information from the database to a file in the IGES standard file
format.
Input:
STRING file_name[] This value specifies the name of the path and the file to be
created.
STRING start_section[] This value specifies the IGES file start section prolog lines.
STRING product_id Product Id for receiving system
STRING author Author
STRING author_org Authors Organization
STRING model_units[] This value specifies the IGES file model units.
LOGICAL entity_values(8) This value specifies the entity type filter status flags used to
specify which Patran entity types will be exported to the IGES
file.
LOGICAL all_groups This value is set to TRUE if all groups are to be exported to the
IGES file.
INTEGER number_of_groups
This value specifies the number of Patran groups to be exported
to the IGES file.
INTEGER group_entity_ids(nu
This value specifies an array containing the IDs of the Patran
mber_of_groups)
groups to be exported to the IGES file.
Output:
INTEGER patran_count(8)
This value returns a list of the number of Patran entities
processed from the database by type.
INTEGER iges_count(21) This value returns the number of IGES entities created by type.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Chapter 2: Basic Functions 115
File Menu
Remarks:
This function can display information popup forms with the following messages:
This function can display fatal popup forms with the following messages:
This function can display a query popup form with the following message:
36000005 %A% File%A% already exists.Do you wish to delete the existing%A% file and
create a new one?
This function can display fatal popup forms listing the messages associated with the status values
returned by a call to the function:
Example:
None
116 PCL Reference Manual
File Menu
Description:
This function imports geometry information from a file in the IGES standard file format into the
Patran database.
Input:
STRING file_name[] This value specifies the name of the path and the file
to be imported.
STRING group_name[31] This value specifies the name of the group to which
the imported geometry will be added.
LOGICAL entity_toggle_values(23) This value specifies the entity type filter status flags
to specify which IGES entity types to import.
LOGICAL color_toggle_values(9) This value defined the entity color filter status flags
to specify which IGES entity colors to import.
STRING color_method[7] This value is used to specify the color definition
entity method used to import color definition
entities.
STRING color_definition[] This value specifies the color definition entities to
import.
LOGICAL all_layers This value should be set to TRUE if all geometry
layers are to be imported.
STRING layer[] This value specifies a string that is used to specify
the geometry layers to be imported.
INTEGER number_of_groups This value is the number of groups defined.
INTEGER group_entity_ids(number_ This array specifies the ID values for each user
of_groups) group.
LOGICAL group_entity_values(20, This value specifies a two dimensional array that
number_of_groups) contains values set to TRUE if an entity is to be
included and FALSE if an entity is not to be included
in the group being imported. The offset in the first
dimension corresponds to the group id in the same
offset of the group_entity_ids input value. The offset
in the second dimension of the array identifies the
entity type.
Chapter 2: Basic Functions 117
File Menu
Remarks:
The input value color_method can have a value of ALL, NONE, or SPECIFY.
This function will provide information popup forms that list the number of IGES entities imported and
Patran entities created.
118 PCL Reference Manual
File Menu
The geometric entities placed in the Patran database will be displayed in the viewport.
Example:
Please see ugi_import_iges (p. 44) in the PCL Reference Manual Examples.
Description:
This function imports geometry information from a file in the IGES standard file format into the Patran
database.
Input:
STRING file_name[] This value specifies the name of the path and the
file to be imported.
INTEGER ipref142 User preference for Curve on Surface (142) entity
representation use flag.
INTEGER patran_count(9)
This value returns the number of Patran entities
written to the database by type.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
The input value color_method can have a value of ALL, NONE, or SPECIFY.
This function will provide information popup forms that list the number of IGES entities imported and
Patran entities created.
The geometric entities placed in the Patran database will be displayed in the viewport.
Example:
Please see ugi_import_iges (p. 44) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 121
File Menu
Description:
This function imports geometry information from a file in the IGES standard file format into the Patran
database.
Input:
STRING file_name[] This value specifies the name of the path and the
file to be imported.
INTEGER ipref142 User preference for Curve on Surface (142) entity
representation use flag.
INTEGER patran_count(9)
This value returns the number of Patran entities
written to the database by type.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
The input value color_method can have a value of ALL, NONE, or SPECIFY.
This function will provide information popup forms that list the number of IGES entities imported and
Patran entities created.
The geometric entities placed in the Patran database will be displayed in the viewport.
Example:
Please see ugi_import_iges (p. 44) in the PCL Reference Manual Examples.
Description:
This function provides information on the contents of an IGES geometry file.
Input:
STRING file_name[] This value specifies the name of the path and the
file to be imported.
LOGICAL query_options(7) This value specifies the types of query operations
to perform. See the remarks below for more
information.
124 PCL Reference Manual
File Menu
LOGICAL create_report This value specifies, when set to TRUE, that the
report information will be written to an Patran
report file. When this value is set to FALSE, a
report file will not be created.
STRING report_name[]
This value specifies the name of the Patran report
file to which query information is written.
Output:
INTEGER entity_count This value returns the number of IGES entities
identified in the IGES geometry file.
INTEGER entity_attributes(12,50) This value returns the IGES entity attributes for
each entity type. The use of this array is described
in the remarks below.
INTEGER num_colors(50) This value returns the number of colors used by the
IGES geometry file.
INTEGER entity_colors(256,50) This value returns the color numbers per entity type
used by the IGES geometry file. See the remarks
below for more information on the use of this
value.
INTEGER num_colors_per(256,50) This value returns the number of colors per entity
type used by the IGES geometry file.
INTEGER num_layers(50) This value reports the number of layers per entity
type in the IGES geometry file.
INTEGER entity_layers(256,50) This value returns the layer numbers per entity type
in the IGES geometry file.
INTEGER num_layers_per(256,50) This value returns the number of layers per entity
type.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See Status Messages for information on any error values returned by this function.
Remarks:
This function will provide an information display listing the contents of the IGES file.
The input value query_options uses the following offsets to control the type of information placed in a
report. When the value at the offset is set to TRUE, the information will be placed in the report. When
the value at the offset is set to FALSE, the listed information will be omitted from the report.
Chapter 2: Basic Functions 125
File Menu
Table 2-10
Offset Description
1 Report the supported IGES entities.
2 Report the IGES geometric entities.
3 Report a tabulated summary of all IGES entities.
4 Report the visible geometric entities.
5 Report the supported IGES entities with
subordinate switches.
6 Report the IGES entity color status.
7 Report the IGES entity level status.
The output value entity_attributes returns the IGES entity attributes for each entity type. Twelve different
attributes are counted for 50 entity types. The second dimensional offsets (1-50) of this array are used to
list the entity counts for each attribute. The first dimensional offsets in the array are used to identify the
entity attributes as follows:
Table 2-11
Offset Description
1 This offset returns the entity type.
2 This offset returns the total number of entities.
3 This offset returns the number of visible entities.
4 This offset returns the number of model space entities.
5 This offset returns the number of parameter space entities.
6 This offset returns the subordinate switch entity value of 0.
7 This offset returns the subordinate switch entity value of 1.
8 This offset returns the subordinate switch entity value of 2.
9 This offset returns the subordinate switch entity value of 3.
10 This offset returns the number of annotation entities.
11 This offset is not used.
12 This offset returns the number of bounded plane entities.
126 PCL Reference Manual
File Menu
The output value entity_colors returns the color numbers per entity type used by the IGES geometry file.
If the color number is negative, its absolute value is an offset into the second dimension of the attributes
returned by the output value entity_attributes where a color definition entity is used to define the color.
The possible positive color numbers and their colors are:
Example:
None.
Description:
This function will export Patran geometry to a Parasolid transmit file.
Input:
STRING filnam[] This value specifies the Parasolid transmit file name to create.
REAL refittol This value specifies the tolerance used to refit Patran geometry
to Parasolid format.
LOGICAL entity_values(3) This value specifies the types of Patran geometric entity types
to export:
Remarks:
None.
Example:
None.
128 PCL Reference Manual
Group Menu
Group Menu
This section is used to describe functions that are used to create, delete, modify and transform groups of
geometric and finite element model entities stored in the database.
ga_group_clear (group_name)
Description:
This function clears a group of all of its members.
Input:
STRING group_name[31] This value specifies the name of the group to clear.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
11000050 The group name is invalid.
11000105 The specified group was not found in the database.
Remarks:
The cleared group and its members remain in the database but the members are no longer associated with
the group. The members of the cleared group can still be viewed if they belong to another group which
is posted to a viewport.
Example:
Please see ga_group_clear (p. 47) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 129
Group Menu
Description:
Create single or multiple groups using different selection methods.
Input:
INTEGER options Defines the creation options in a bit mask:
GA_GROUP_CREATE_SELECTION 0X00000001
GA_GROUP_CREATE_PROP_SETS 0X00000002
GA_GROUP_CREATE_PROP_TYPE 0X00000004
GA_GROUP_CREATE_LBC_SETS 0X00000008
GA_GROUP_CREATE_LBC_TYPE 0X00000010
GA_GROUP_CREATE_MATERIAL 0X00000020
GA_GROUP_CREATE_ELM_TOPS 0X00000040
GA_GROUP_CREATE_ELM_SHAPE 0X00000080
GA_GROUP_CREATE_ELEM_IDS 0X00000100
GA_GROUP_CREATE_MPC_TYPE 0X00000200
GA_GROUP_CREATE_BOOLEAN 0X00000400
STRING group_name [32] Group name.
INTEGER num_select_1 The starting element id for an option value of
GA_GROUP_CREATE_ELEM_IDS
STRING select_1 [32] () The first selected list of entities.
INTEGER num_select_2 The ending element id for an option value of
GA_GROUP_CREATE_ELEM_IDS
STRING select_2 [32] () The second selected list of entities.
Output:
INTEGER <Return Value> 0 if no error have occured.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000049 A group with the given name is already in the database.
11000050 The group name is invalid.
11000097 There is not enough disk space to complete operation.
11000098 A fatal error has occurred in the database. Database is corrupted.
Remarks:
The group created through the use of this function must be posted to a viewport before any added entities
can be viewed.
130 PCL Reference Manual
Group Menu
Example:
None
ga_group_current_set (group_name)
Description:
This function will set any new entities as members of the specified group and then post the specified
group to the current viewport.
Input:
STRING group_name[31] This value specifies the name of the group to which new entities
will be set and that will be posted to the current viewport,
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000049 A group with the given name is already in the database.
11000098 A fatal error has occurred in the database. Database is corrupted.
Remarks:
None
Example:
Please see ga_group_current_set (p. 48) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 131
Group Menu
ga_group_delete (group_name)
Description:
This function will delete a group from the database.
Input:
STRING group_name[31] This value specifies the name of the group. Setting this string to
nothing or will allow the use of the current group to be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000050 The group name is invalid.
11000121 There is not a current group defined.
11000140 The group can not be deleted while selected as the current group of any viewport.
11000105 The specified group was not found in the database.
Remarks:
Any disassociated members of the deleted group remain in the database. They can only be viewed if they
are members of or added as members to another group which is posted to a viewport.
Example:
Please see ga_group_delete (p. 49) in the PCL Reference Manual Examples.
132 PCL Reference Manual
Group Menu
Description:
This function changes the current display property list associated with a group and posts the group to
the current viewport.
Input:
STRING group_name[31] This value specifies the name of the group. Setting this string to
nothing or will allow the use of the current group.
STRING display_list[31] This value is the name of the display property list.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000118 There is no display property posted to the group.
11000121 There is not a current group defined.
Remarks:
None
Example:
Please see ga_group_display_set (p. 50) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 133
Group Menu
Description:
This function adds a list of entities as members to a group.
Input:
STRING group_name[31] This value specifies the name of the group to which the
entities will be added. Setting this string to nothing or will
allow the use of the current group.
STRING entities[] This value specifies the list of entities to be added to the
group.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1000025 Error attempting to allocate virtual memory.
11000011 The entity is not contained in the specified group.
11000012 The entity is already contained in the specified group.
11000050 The group name is invalid.
11000078 The specified entity could not be found in the database
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000121 There is not a current group defined.
Remarks:
Entities can be added as members to any number of groups.
Example:
Please see ga_group_entity_add (p. 51) in the PCL Reference Manual Examples.
134 PCL Reference Manual
Group Menu
Description:
This function will remove a list of entities from a group.
Input:
STRING group_name[31] This value specifies the name of the group. Setting this string
to nothing or will allow the use of the current group.
STRING entities[] This value specifies the list of entities to be disassociated
from the group.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000050 The group name is invalid.
11000121 There is not a current group defined.
11000011 The entity is not contained in the specified group.
Remarks:
This function will not remove an entity from the database but will remove its association with the
specified group.
Removed entities that are members of another group can be posted to and redisplayed in the viewport by
pressing the repaint icon on the right end of the menu bar.
Example:
Please see ga_group_entity_remove (p. 53) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 135
Group Menu
ga_group_members_delete (group_name)
Description:
This function will delete all of the entities from a group.
Input:
STRING group_name[31] This value specifies the name of the group. Setting this string to
nothing or will allow the use of the current group.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000121 There is not a current group defined.
11000127 The group does not have any entities in it.
Remarks:
This function will delete all of the entities associated with the specified group even if they are members
of other groups as well.
This function will delete all entities associated with the specified group except for any nodes that are
associated with an element or MPC which is not a member of the targeted group.
Example:
Please see ga_group_members_delete (p. 54) in the PCL Reference Manual Examples.
136 PCL Reference Manual
Group Menu
Description:
This function moves a group of model geometry and FEM entities from one place in the model space
to another.
Input:
INTEGER ngroups This value specifies the number of groups to copy.
STRING group_names[] This value specifies the names of the groups that will have
their positions translated. Set this string to to transform
the current group.
STRING coordinate_frame_id[] This value specifies the reference coordinate frame.
STRING translation_vector[] This value specifies the group translation direction and
distance.
INTEGER action_flag This value specifies whether or not to transform
Loads/Boundary Conditions and Properties:
16=transform Properties
Remarks:
See All About Groups (Ch. 5) in the Patran Reference Manual for
more information.
This function can display the following messages in a popup form:
Description:
This function moves a group of model geometry and FEM entities to a different space within the
model.
Input:
INTEGER ngroups This value specifies the number of groups to copy.
STRING group_names[] This value specifies the names of the groups that will have
their positions translated. Set this string to to transform
the current group.
STRING coordinate_frame_id[] This value specifies the reference coordinate frame.
STRING translation_vector[] This value specifies the group translation direction.
REAL vector_magnitude This value specifies the group translation distance.
LOGICAL reverse_dir This value specifies whether or not to reverse the direction
vector.
INTEGER action_flag This value specifies whether or not to transform
Loads/Boundary Conditions and Properties:
16=transform Properties
Remarks:
See All About Groups (Ch. 5) in the Patran Reference Manual for
more information.
This function can display a fatal popup form with the following messages:
This function can display the following messages in a popup form:
140 PCL Reference Manual
Group Menu
Description:
This function sets the precision of the rendering for a specified group.
Input:
STRING group_name[] This value specifies the name of the group. Set this string to
nothing or to use of the current group.
INTEGER precision_status This is the value to be used as the precision for the group
which can have the following values: 0 for speed, 1 for
accuracy.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000121 There is not a current group defined.
Chapter 2: Basic Functions 141
Group Menu
Remarks:
See the listing for this function in Broken, Obsolete, Modified and New Functions for further information.
Example:
Please see ga_group_precision_set (p. 55) in the PCL Reference Manual Examples.
Description:
This function renames a group.
Input:
STRING original_name[31] This value specifies the original name of the group.
Setting this string to nothing or will allow the use of the
current group.
STRING new_name[31] This value specifies the new name of the group.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000121 There is not a current group defined.
Remarks:
None.
Example:
Please see ga_group_rename (p. 56) in the PCL Reference Manual Examples.
142 PCL Reference Manual
Group Menu
Description:
This function creates a new set of entities which are a mirror of the entities contained in the named
group.
Input:
STRING group_name[31] This value specifies the name of the group to be mirrored.
This value can be set to to mirror the current group.
STRING plane[] This value specifies the plane around which the mirror
transformation will take place.
REAL offset This value specifies a distance along a vector that is normal
to the mirror plane, starting at the mirror plane surface. This
distance defines an offset for the placement of the mirrored
entities.
LOGICAL delete_original This value, when set to TRUE, specifies the deletion of the
original geometry being mirrored.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the original
geometry IDs for the mirrored entities to be used.
LOGICAL reverse This value, when set to TRUE, will allow the parametric
direction of the curves and surfaces of the mirrored
geometry to be reversed.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1000054 An invalid geometric entity type was used as input. The valid entity type to use
is%A%. Unable to process request.
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
Chapter 2: Basic Functions 143
Group Menu
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049 LpParseExpression: Excess left parenthesis detected.
14000050 LpParseExpression: Excess right parenthesis detected.
14000208 LpSublistAttributeGet: Curve evaluator error
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry
14000211 LpSublistAttributeGet: Surface evaluator error
14000281 LpExpandPclVariables: Virtual memory is full.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
14000308 LpEval: Memory exhausted preparing to evaluate pick.
Remarks:
This function is implemented through a call to the function ga_group_transform_mirror2().
The call to the function ga_group_transform_mirror2() is done with the lbc_copy_sets,
lbc_transform_sets, prop_copy_sets, and prop_transform_sets input values all set to .
The new entities created will become members of the current group of the current viewport.
Load boundary conditions (LBC) and element property sets assigned to the named group are not mirrored
to the new entities. To mirror the load boundary conditions and element property sets, use the function
ga_group_transform_mirror2().
See All About Groups (Ch. 5) in the Patran Reference Manual for
more information.
This function can display a warning popup form with the following messages:
1000054 An invalid geometric entity type was used as input. The valid entity type to use
is%A%. Unable to process request.
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
144 PCL Reference Manual
Group Menu
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000208 LpSublistAttributeGet: Curve evaluator error
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry
14000211 LpSublistAttributeGet: Surface evaluator error
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
This function can display a fatal popup form with the following messages:
Example:
Please see ga_group_transform_mirror (p. 57) in the PCL Reference Manual Examples
Description:
This function creates a set of entities which are a mirror of the entities contained in the named group.
Input:
Chapter 2: Basic Functions 145
Group Menu
Remarks:
If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets
input values, the load boundary conditions will be copied and not transformed.
If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the
property set will be copied and not transformed.
If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and
prop_transform_sets are not used they should be set up as an array of one string set to .
The new entities created will become members of the current group of the current viewport.
See All About Groups (Ch. 5) in the Patran Reference Manual for more information.
This function can display a warning popup form with the following messages:
1000054 An invalid geometric entity type was used as input. The valid entity type to use
is%A%. Unable to process request.
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000208 LpSublistAttributeGet: Curve evaluator error
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry
14000211 LpSublistAttributeGet: Surface evaluator error
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
148 PCL Reference Manual
Group Menu
This function can display a fatal popup form with the following messages:
Example:
Please see ga_group_transform_mirror2 (p. 58) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 149
Group Menu
Description:
This function creates a set of entities which are a copy of the entities contained in the named group,
pivoted around a point defined in space.
Input:
STRING group_name[31] This value specifies the name of the group to be pivoted.
This value can be set to to pivot the current group.
STRING pivot_point[] This value specifies the point around which the model and
FEM geometry will be pivoted.
STRING start_point[] This value specifies the starting point from which the pivot
operation will take place.
STRING end_point[] This value specifies the ending point from which the pivot
operation will take place.
LOGICAL delete_original This value, when set to TRUE, will cause the original
geometry being pivoted to be deleted.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the original
geometry IDs for the pivoted entities to be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1 This is an internal status condition. There is no corresponding status message in the
message database.
2 This is an internal status condition. There is no corresponding status message in the
message database.
3 This is an internal status condition. There is no corresponding status message in the
message database.
1000211 The length of the Axis equals zero.
1000302 The three points specified are nearly collinear.
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
150 PCL Reference Manual
Group Menu
Remarks:
This function is implemented through a call to the function ga_group_transform_pivot2().
The call to the function ga_group_transform_pivot2() is done with the lbc_copy_sets,
lbc_transform_sets, prop_copy_sets, and prop_transform_sets input values all set to .
The new entities created will become members of the current group of the current viewport.
Load boundary conditions (LBC) and element property sets assigned to the named group are not added
to the new entities. To add the load boundary conditions and element property sets, use the function
ga_group_transform_pivot2().
See All About Groups (Ch. 5) in the Patran Reference Manual for more information.
This function can display a fatal popup form with the following messages:
This function can display a popup forms with the following messages:
Example:
Please see ga_group_transform_pivot (p. 60) in the PCL Reference Manual Examples.
Description:
This function creates a set of entities which are a copy of the entities contained in the named group,
pivoted around a point defined in space.
Input:
STRING group_name[31] This value specifies the name of the group to be
pivoted. This value can be set to to pivot the current
group.
STRING pivot_point[] This value specifies the point around which the model
and FEM geometry will be pivoted.
STRING start_point[] This value specifies the starting point from which the
pivot operation will take place.
STRING end_point[] This value specifies the ending point from which the
pivot operation will take place.
LOGICAL delete_original This value, when set to TRUE, will cause the original
geometry being pivoted to be deleted.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the
original geometry IDs for the pivoted entities to be
used.
STRING lbc_copy_sets[]() This value specifies an array of strings, terminated by
an empty string, listing the names of the load boundary
condition sets to be copied, with no coordinate
transformations, to the copied entities.
152 PCL Reference Manual
Group Menu
Remarks:
If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets
input values, the load boundary conditions will be copied and not transformed.
If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the
property set will be copied and not transformed.
If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and
prop_transform_sets are not used they should be set up as an array of one string set to .
The new entities created will become members of the current group of the current viewport.
See All About Groups (Ch. 5) in the Patran Reference Manual for more information.
This function can display a fatal popup form with the following messages:
This function can display popup forms with the following messages:
Example:
Please see ga_group_transform_pivot2 (p. 61) in the PCL Reference Manual Examples.
154 PCL Reference Manual
Group Menu
Description:
This function will do a rigid body positional and rotational translation of a group of model geometry
and FEM entities.
Input:
STRING group_name[31] This value specifies the name of the group that will have
its position transformed. This value can be set to to
transform the current group.
STRING start_point_1[] This value specifies the first point in space used to define
a coordinate system for the starting position of the
position translation operation.
STRING start_point_2[] This value silicifies the second point in space used to
define a coordinate system for the starting position of the
position translation operation.
STRING start_point_3[] This value specifies the third point in space used to define
a coordinate system for the starting position of the
position translation operation.
STRING end_point_1[] This value specifies the first point in space used to define
a coordinate system for the ending position of the
position translation operation.
STRING end_point_2[] This value specifies the second point in space used to
define a coordinate system for the ending position of the
position translation operation.
STRING end_point_3[] This value specifies the third point in space used to define
a coordinate system for the ending position of the
position translation operation.
LOGICAL delete_original This value, when set to TRUE, will cause the original
geometry being transformed to be deleted.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the original
geometry IDs for the pivoted entities to be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Chapter 2: Basic Functions 155
Group Menu
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1000211 The length of the Axis equals zero.
1000302 The three points specified are nearly collinear.
13000088 Preference not found
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049 LpParseExpression: Excess left parenthesis detected.
14000050 LpParseExpression: Excess right parenthesis detected.
14000208 LpSublistAttributeGet: Curve evaluator error
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry
14000211 LpSublistAttributeGet: Surface evaluator error
14000281 LpExpandPclVariables: Virtual memory is full.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
14000308 LpEval: Memory exhausted preparing to evaluate pick.
Remarks:
Both the starting_point and the ending_point three point sets of input values define a temporary
coordinate frame. The positional and angular differences between the two frames establish the translation
vector and planar rotation angles which are used to transform the named group.
The vector extending from the input values starting_point_1 to ending_point_1 define the positional
translation component of this operation.
The angular relationship between the pair of vectors defined by starting_point_1 and starting_point_2,
and the vectors ending_point_1 and ending_point2 and the angular relationship between the pair of
vectors defined by starting_point_1 and starting_point_3, and the vectors ending_point_1 and
ending_point3 define the planar translation angles for the positional translation operation.
This function is implemented through a call to the function ga_group_transform_position2().
The call to the function ga_group_transform_position2() is done with the lbc_copy_sets,
lbc_transform_sets, prop_copy_sets, and prop_transform_sets input values all set to .
The new entities created will become members of the current group of the current viewport.
156 PCL Reference Manual
Group Menu
Load boundary conditions (LBC) and element property sets assigned to the named group are not added
to the new entities. To add the load boundary conditions and element property sets, use the function
ga_group_transform_position2().
See All About Groups (Ch. 5) in the Patran Reference Manual for more information.
This function can display a fatal popup form with the following messages:
Example:
Please see ga_group_transform_position (p. 63) in the PCL Reference Manual Examples.
Description:
This function will do a rigid body positional and rotational translation of a group of model geometry
and FEM entities.
Input:
STRING group_name[31] This value specifies the name of the group that will have
its position transformed. This value can be set to to
transform the current group.
STRING start_point_1[] This value specifies the first point in space used to define
a coordinate system for the starting position of the
position translation operation.
STRING start_point_2[] This value specifies the second point in space used to
define a coordinate system for the starting position of the
position translation operation.
STRING start_point_3[] This value specifies the third point in space used to
define a coordinate system for the starting position of the
position translation operation.
Chapter 2: Basic Functions 157
Group Menu
STRING end_point_1[] This value specifies the first point in space used to define
a coordinate system for the ending position of the
position translation operation.
STRING end_point_2[] This value specifies the second point in space used to
define a coordinate system for the ending position of the
position translation operation.
STRING end_point_3[] This value specifies the third point in space used to
define a coordinate system for the ending position of the
position translation operation.
LOGICAL delete_original This value, when set to TRUE, will cause the original
geometry being transformed to be deleted.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the
original geometry IDs for the pivoted entities to be used.
STRING lbc_copy_sets[]() This value specifies an array of strings, terminated by an
empty string, listing the names of the load boundary
condition sets to be copied, with no coordinate
transformations, to the copied entities.
STRING lbc_transform_sets[]() This value specifies an array of strings, terminated by an
empty string, listing the names of the load boundary
condition sets to be added to the transformed entities.
STRING prop_copy_sets[]() This value specifies an array of strings, terminated by an
empty string, listing the names of the property sets to be
copied, with no coordinate transformations, to the
transformed entities.
STRING prop_transform_sets[]() This value specifies an array of strings, terminated by an
empty string, listing the names of the property sets to be
added to the transformed entities.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1000211 The length of the Axis equals zero.
1000302 The three points specified are nearly collinear.
13000088 Preference not found
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
158 PCL Reference Manual
Group Menu
Remarks:
If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets
input values, the load boundary conditions will be copied and not transformed.
If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the
property set will be copied and not transformed.
If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and
prop_transform_sets are not used they should be set up as an array of one string set to .
The new entities created will become members of the current group of the current viewport.
See All About Groups (Ch. 5) in the Patran Reference Manual for more information.
This function can display a fatal popup form with the following messages:
Example:
Please see ga_group_transform_position2 (p. 65) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 159
Group Menu
Description:
This function will do a rigid body rotational translation of a group of model geometry and FEM entities.
Input:
STRING group_name[31] This value specifies the name of the group that will have
its position rotated. This value can be set to to rotate
the current group.
STRING coordinate_frame_id[] This value specifies the reference coordinate frame.
STRING rotation_axis[] This value specifies a vector that is normal to the plane
of rotation. This vector forms the axis around which the
rotation translation will take place.
REAL rotation_angle[] This value specifies the angle of displacement in
degrees that will take place around the axis of rotation.
REAL offset_angle[] This value specifies an angular offset in degrees around
the axis of rotation for the start of the rotational
translation.
LOGICAL delete_original This value, when set to TRUE, will cause the original
geometry being transformed to be deleted.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the
original geometry IDs for the pivoted entities to be used.
INTEGER repeat_count This value specifies the number of times to repeat the
transform with each additional transform being
positioned relative to the previous transformation
results.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1 This is an internal status condition. There is no corresponding status message in the
message database.
2011004 The Repeat Count must be greater than 0.
160 PCL Reference Manual
Group Menu
Remarks:
This function is implemented through a call to the function ga_group_transform_rotate2().
The call to the function ga_group_transform_rotate2() is done with the lbc_copy_sets,
lbc_transform_sets, prop_copy_sets, and prop_transform_sets input values all set to .
The new entities created will become members of the current group of the current viewport.
Load boundary conditions (LBC) and element property sets assigned to the named group are not added
to the new entities. To add the load boundary conditions and element property sets, use the function
ga_group_transform_rotate2().
See All About Groups (Ch. 5) in the Patran Reference Manual for more information.
This function can display a fatal popup form with the following messages:
This function can display the following messages in a popup form:
Example:
Please see ga_group_transform_rotate (p. 67) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 161
Group Menu
Description:
This function will do a rigid body rotational translation of a group of model geometry and FEM
entities.
Input:
STRING group_name[31] This value specifies the name of the group that will
have be rotated. This value can be set to to rotate the
current group.
STRING coordinate_frame_id[] This value specifies the reference coordinate frame.
STRING rotation_axis[] This value specifies a vector that is normal to the plane
of rotation. This vector forms the axis around which the
rotation translation will take place.
REAL rotation_angle[] This value specifies the angle of displacement in
degrees that will take place around the axis of rotation.
REAL offset_angle[] This value specifies an angular offset in degrees around
the axis of rotation for the start of the rotational
translation.
LOGICAL delete_original This value, when set to TRUE, will cause the original
geometry being transformed to be deleted.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the
original geometry IDs for the pivoted entities to be
used.
INTEGER repeat_count This value specifies the number of times to repeat the
transform with each additional transform being
positioned relative to the previous transformation
results.
STRING lbc_copy_sets[]() This value specifies an array of strings, terminated by
an empty string, listing the names of the load boundary
condition sets to be copied, with no coordinate
transformations, to the copied entities.
STRING lbc_transform_sets[]() This value specifies an array of strings, terminated by
an empty string, listing the names of the load boundary
condition sets to be added to the transformed entities.
162 PCL Reference Manual
Group Menu
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1 This is an internal status condition. There is no corresponding status message in the
message database.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049 LpParseExpression: Excess left parenthesis detected.
14000050 LpParseExpression: Excess right parenthesis detected.
14000208 LpSublistAttributeGet: Curve evaluator error
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry
14000211 LpSublistAttributeGet: Surface evaluator error
14000281 LpExpandPclVariables: Virtual memory is full.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
14000308 LpEval: Memory exhausted preparing to evaluate pick.
Remarks:
If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets
input values, the load boundary conditions will be copied and not transformed.
Chapter 2: Basic Functions 163
Group Menu
If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the
property set will be copied and not transformed.
If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and
prop_transform_sets are not used they should be set up as an array of one string set to .
The new entities created will become members of the current group of the current viewport.
See All About Groups (Ch. 5) in the Patran Reference Manual for more information.
This function can display a fatal popup form with the following messages:
Example:
Please see ga_group_transform_rotate2 (p. 68) in the PCL Reference Manual Examples.
164 PCL Reference Manual
Group Menu
Description:
This function will change the scale of the selected group of model geometry and FEM entities.
Input:
STRING group_name[31] This value specifies the name of the group that will have
its position scaled. This value can be set to to scale the
current group.
STRING coordinate_frame_id[] This value specifies the reference coordinate frame.
STRING origin_point[] This value specifies a point in space from which the
group will be scaled.
REAL scale_factors[3] This value specifies the scale factors in the X, Y, and Z
coordinate axis.
LOGICAL delete_original This value, when set to TRUE, will cause the original
geometry being transformed to be deleted.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the original
geometry IDs for the pivoted entities to be used.
INTEGER repeat_count This value specifies the number of times to repeat the
transform with each additional transform being
positioned relative to the previous transformation results.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049 LpParseExpression: Excess left parenthesis detected.
14000050 LpParseExpression: Excess right parenthesis detected.
14000208 LpSublistAttributeGet: Curve evaluator error
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry
Chapter 2: Basic Functions 165
Group Menu
Remarks:
This function is implemented through a call to the function ga_group_transform_scale2().
The call to the function ga_group_transform_scale2() is done with the lbc_copy_sets,
lbc_transform_sets, prop_copy_sets, and prop_transform_sets input valueinput values all set to .
The new entities created will become members of the current group of the current viewport.
Load boundary conditions (LBC) and element property sets assigned to the named group are not added
to the new entities. To add the load boundary conditions and element property sets, use the function
ga_group_transform_scale2().
See All About Groups (Ch. 5) in the Patran Reference Manual for
more information.
This function can display a fatal popup form with the following messages:
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
See the listing for this function in Broken, Obsolete, Modified and New Functions for further information.
Example:
Please see ga_group_transform_scale (p. 71) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 167
Group Menu
Description:
This function will change the scale of the selected group of model geometry and FEM entities.
Input:
STRING group_name[31] This value specifies the name of the group that will
have its position scaled. This value can be set to to
scale the current group.
STRING coordinate_frame_id[] This value specifies the reference coordinate frame.
STRING origin_point[] This value specifies a point in space from which the
group will be scaled.
REAL scale_factors[3] This value specifies the scale factors in the X, Y, and
Z coordinate axis.
LOGICAL delete_original This value, when set to TRUE, will cause the original
geometry being transformed to be deleted.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the
original geometry IDs for the pivoted entities to be
used.
INTEGER repeat_count This value specifies the number of times to repeat the
transform with each additional transform being
positioned relative to the previous transformation
results.
STRING lbc_copy_sets[]() This value specifies an array of strings, terminated by
an empty string, listing the names of the load boundary
condition sets to be copied, with no coordinate
transformations, to the copied entities.
STRING lbc_transform_sets[]() This value specifies an array of strings, terminated by
an empty string, listing the names of the load boundary
condition sets to be added to the transformed entities.
STRING prop_copy_sets[]() This value specifies an array of strings, terminated by
an empty string, listing the names of the property sets
to be copied, with no coordinate transformations, to
the transformed entities.
168 PCL Reference Manual
Group Menu
Remarks:
If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets
input values, the load boundary conditions will be copied and not transformed.
If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the
property set will be copied and not transformed.
If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and
prop_transform_sets are not used they should be set up as an array of one string set to .
The new entities created will become members of the current group of the current viewport.
See All About Groups (Ch. 5) in the Patran Reference Manual for more information.
This function can display a fatal popup form with the following messages:
Chapter 2: Basic Functions 169
Group Menu
Description:
This function will move or translate a group of model geometry and FEM entities from one place in the
model space to another.
Input:
STRING group_name[31] This value specifies the name of the group that will
have its position translated. This value can be set to
to transform the current group.
STRING coordinate_frame_id[] This value specifies the reference coordinate frame.
STRING translation_vector[] This value specifies the direction and distance that the
group will be translated.
LOGICAL delete_original This value, when set to TRUE, will cause the original
geometry being transformed to be deleted.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the
original geometry IDs for the pivoted entities to be
used.
INTEGER repeat_count This value specifies the number of times to repeat the
transform with each additional transform being
positioned relative to the previous transformation
results.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
170 PCL Reference Manual
Group Menu
Remarks:
This function is implemented through a call to the function ga_group_transform_translate2().
The call to the function ga_group_transform_translate2() is done with the lbc_copy_sets,
lbc_transform_sets, prop_copy_sets, and prop_transform_sets input values all set to .
The new entities created will become members of the current group of the current viewport.
Load boundary conditions (LBC) and element property sets assigned to the named group are not added
to the new entities. To add the load boundary conditions and element property sets, use the function
ga_group_transform_translate2().
See All About Groups (Ch. 5) in the Patran Reference Manual for more information.
This function can display a fatal popup form with the following messages:
Example:
Please see ga_group_transform_translate (p. 75) in the PCL Reference Manual Examples.
Description:
This function will copy a group of model geometry and FEM entities from one place in the model space
to another.
Input:
INTEGER ngroups This value specifies the number of groups to copy.
STRING group_names[] This value specifies the names of the groups that will
have their positions translated. This value can be set to
to transform the current group.
STRING coordinate_frame_id[] This value specifies the reference coordinate frame.
STRING translation_vector[] This value specifies the group translation direction and
distance.
INTEGER action_flag This value specifies whether or not to transform
Loads/Boundary Conditions and Properties:
16=transform Properties
Remarks:
See All About Groups (Ch. 5) in the Patran Reference Manual for
more information.
This function can display a fatal popup form with the following messages:
Description:
This function will move or translate a group of model geometry and FEM entities from one place in
the model space to another.
Input:
STRING group_name[31] This value specifies the name of the group that will
have its position translated. This value can be set to
to transform the current group.
STRING coordinate_frame_id[] This value specifies the reference coordinate frame.
STRING translation_vector[] This value specifies the direction and distance that
the group will be translated.
LOGICAL delete_original This value, when set to TRUE, will cause the
original geometry being transformed to be deleted.
LOGICAL use_original_labels This value, when set to TRUE with the input value
delete_original being set to TRUE, will allow the
original geometry IDs for the pivoted entities to be
used.
Chapter 2: Basic Functions 175
Group Menu
Remarks:
If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets
input values, the load boundary conditions will be copied and not transformed.
If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the
property set will be copied and not transformed.
If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, prop_transform_sets
are not used they should be set up as an array of one string set to .
The new entities created will become members of the current group of the current viewport.
See All About Groups (Ch. 5) in the Patran Reference Manual for
more information.
This function can display a fatal popup form with the following messages:
Example:
Please see ga_group_transform_translate2 (p. 77) in the PCL Reference Manual Examples.
Description:
This function will copy a group of model geometry and FEM entities from one place in the model space
to another.
Input:
INTEGER Ngroups This value specifies the number of groups to copy.
STRING group_names[] This value specifies the names of the groups that will
have their positions translated. This value can be set to
to transform the current group.
STRING coordinate_frame_id[] This value specifies the reference coordinate frame.
STRING translation_vector[] This value specifies the direction that the group will be
translated.
REAL vector_magnitude This value specifies the distance that the group will be
translated.
LOGICAL reverse_dir This value specifies whether or not to reverse the
direction vector.
INTEGER action_flag This value specifies whether or not to transform
Loads/Boundary Conditions and Properties:
STRING new_group_names This value specifies the string associated with the
argument name_flag. This will be either a:
Remarks:
See All About Groups (Ch. 5) in the Patran Reference Manual for more information.
This function can display a fatal popup form with the following messages:
Description:
This function will get a list of all the members of a group.
Input:
STRING group_name[31] This value specifies the name of the group that will be
retrieved. This value can be set to to retrieve the
current group.
Output:
STRING members[VIRTUAL] This value returns a list of the members of the group.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8104003 Out of room in destination format string.
8107002 Last command aborted.
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
180 PCL Reference Manual
Group Menu
Remarks:
Space is internally allocated for the output value members. It is the responsibility of the calling function
to free the allocated string storage space.
Example:
Please see uil_group_members_get (p. 78) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 181
Viewing Menu
Viewing Menu
This section is used to describe functions that are used to create, delete, modify and retrieve the settings
of named views stored in the database.
Description:
This function gets the absolute x, y, and z angles of rotation around the axes of the global model
coordinate system of the specified view.
Input:
STRING name_of_view[31] This value specifies the name of the view from which the
absolute angles will be obtained. If this value is set to
nothing or , the current view will be used.
Output:
REAL angle_x This value returns the rotation about the x axis.
REAL angle_y This value returns the rotation about the y axis.
REAL angle_z This value returns the rotation about the z axis.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
Remarks:
None
Example:
Please see ga_view_aa_get (p. 126) in the PCL Reference Manual Examples.
182 PCL Reference Manual
Viewing Menu
Description:
This function sets the absolute x, y, and z angles of rotation around the axes of the global model
coordinate system for the current view.
Input:
REAL angle_x This value specifies the angle of rotation for the x axis.
REAL angle_y This value specifies the angle of rotation for the y axis.
REAL angle_z This value specifies the angle of rotation for the z axis.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000014 Viewport not found
Remarks:
None
Example:
Please see ga_view_aa_set (p. 127) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 183
Viewing Menu
Description:
This function sets the x, y, and z angles of rotation around the axes of the global model coordinate
system for the current view relative to current rotational position.
Input:
REAL angle_x This value specifies the angle of rotation for the x axis.
REAL angle_y This value specifies the angle of rotation for the y axis.
REAL angle_z This value specifies the angle of rotation for the z axis.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000014 Viewport not found
Remarks:
None.
Example:
Please see ga_view_ar_set (p. 128) in the PCL Reference Manual Examples.
184 PCL Reference Manual
Viewing Menu
Description:
This function gets the distance of the back clipping plane.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the back clipping plane will be obtained. If this value
is set to nothing or , the current view will be used.
Output:
REAL distance This value returns the location of back clipping
plane.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000014 Viewport not found
Remarks:
The back clipping plane distance is the distance from the origin of global model coordinate frame to the
back clipping plane along the z axis.
This distance must be less than the distance of the front clipping plane.
Example:
Please see ga_view_back_get (p. 129) in the PCL Reference Manual Examples.
ga_view_back_set (distance)
Description:
This function sets the distance of the back clipping plane.
Input:
Chapter 2: Basic Functions 185
Viewing Menu
REAL distance This value sets the location of back clipping plane.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
The back clipping plane distance is the distance from the origin of global model coordinate frame to the
back clipping plane along the z axis.
This distance must be less than the distance of the front clipping plane.
Example:
Please see ga_view_back_set (p. 131) in the PCL Reference Manual Examples.
186 PCL Reference Manual
Viewing Menu
Description:
This function will return the on/off status for capping.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the capping status will be obtained. If this value is set
to nothing or , the current view will be used.
Output:
LOGICAL capping_status This value returns the on/off status of capping. It will
be set TRUE for on, FALSE for off.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
Remarks:
None
Example:
Please see ga_view_capping_get (p. 132) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 187
Viewing Menu
ga_view_capping_set (capping_status)
Description:
This function sets the on/off status of capping for the current view.
Input:
LOGICAL capping_status This value sets the status of capping to either
TRUE for on, or FALSE for off.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_capping_set (p. 133) in the PCL Reference Manual Examples.
188 PCL Reference Manual
Viewing Menu
Description:
This function returns the location of the center of the named view in the global model coordinate
system.
Input:
STRING name_of_view[31] This value specifies the name of the view from
which the center location will be obtained. If this
value is set to nothing or , the current view will be
used.
Output:
REAL coordinate_x This value returns the x coordinate for the center of
the view.
REAL coordinate_y This value returns the y coordinate for the center of
the view.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
Remarks:
None
Example:
Please see ga_view_center_get (p. 134) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 189
Viewing Menu
Description:
This function centers the current view around a specified point in the global model coordinate system.
Input:
REAL coordinate_x This value specifies the x coordinate around which
the view will be centered.
REAL coordinate_y This value specifies the x coordinate around which
the view will be centered.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_center_set (p. 136) in the PCL Reference Manual Examples.
190 PCL Reference Manual
Viewing Menu
Description:
The view center will be set such that a Node, point or world coordinates can be used as the center of
the current viewport.
Input:
STRING vpname Viewport name
STRING center New view center pick
LOGICAL rctr True if rotation center to be set also
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
None
Remarks:
1. This sets both the view center and the rotation center.
2. The center must be specified as coordinate values, a node, or a geometric point surrounded by
quotes. Examples: "[10.0, 5.0, -3.0]", "Node 57", "Point 86"
Example:
None
Chapter 2: Basic Functions 191
Viewing Menu
Description:
This function will return the on/off status for clipping.
Input:
STRING name_of_view[31] This value specifies the name of the view from which the
clipping status will be obtained. If this value is set to
nothing or , the current view will be used.
Output:
LOGICAL clipping_status This value returns the on/off status of capping. It will be set
TRUE for on, FALSE for off.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
Remarks:
None
Example:
Please see ga_view_clipping_get (p. 137) in the PCL Reference Manual Examples.
192 PCL Reference Manual
Viewing Menu
ga_view_clipping_set (clipping_status)
Description:
This function sets the on/off status of clipping for the current view.
Input:
LOGICAL clipping_status This value sets the status of clipping to either TRUE
for on, or FALSE for off.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_clipping_set (p. 138) in the PCL Reference Manual Examples.
Description:
This function changes the size and center location of the current view.
Input:
REAL point_1(3) This value specifies a point that is the location of the
corner point of a box that is on a diagonal to point_2.
See the remarks below for more information.
Chapter 2: Basic Functions 193
Viewing Menu
REAL point_2(3) This value specifies a point that is the location of the
corner point of a box that is on a diagonal to point_1.
See the remarks below for more information.
REAL aspect_ratio This value specifies the relationship between the size
of the box and the zoom value applied to the view.
See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
The box defined by the input values point_1 and point_2 defines where the center of the view will be
placed and along with the aspect_ratio input value, the zoom value applied to the view.
The input value aspect_ratio should be a positive non-zero value. Setting the input value aspect_ratio to
zero will cause a divide by zero error followed by a core dump. If the aspect_ratio is less than 0.0, the
zoom factor will be set to a negative value and the results will be unpredictable.
Each of the input point arrays have offsets (1, 2, 3) that correspond to the axes of the global model
coordinate system (x, y, z).
Example:
Please see ga_view_corners_set (p. 139) in the PCL Reference Manual Examples.
194 PCL Reference Manual
Viewing Menu
Description:
This function will create a named view and post it to a viewport.
Input:
STRING name_of_view[31] This value specifies the name of the view. If this
value is set to nothing or , an error status value will
be returned by the function.
STRING viewport_name[31] This value specifies the name of the viewport to
which the view will be posted. If this value is set to
nothing or , the current viewport will be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000153 The specified Named View already exists.
13000007 An unspecified database error occurred
13000014 Viewport not found
Remarks:
None
Example:
Please see ga_view_create (p. 140) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 195
Viewing Menu
ga_view_delete (name_of_view)
Description:
This function deletes a named view.
Input:
STRING name_of_view[31] This value specifies the name of the view to be
deleted. If this value is set to nothing or , the
current view will be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_delete (p. 142) in the PCL Reference Manual Examples.
196 PCL Reference Manual
Viewing Menu
Description:
The function will get the distance from the center of the named view to the view plane along the z axis
of the global model coordinate system.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the distance will be obtained. If this value is set to
nothing or , the current view will be used.
Output:
REAL distance This value returns the distance from the center of the
named view to the view plane. The output value
distance will always be less than the observer
position distance.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
Remarks:
None
Example:
Please see ga_view_dist_get (p. 143) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 197
Viewing Menu
ga_view_dist_set (distance)
Description:
This function will set the distance from the center of the current view to the view plane along the z axis
of the global model coordinate system.
Input:
REAL distance This value specifies the distance from the view plane to the
center of the current view. This input value must be less than the
observer position distance.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_dist_set (p. 144) in the PCL Reference Manual Examples.
198 PCL Reference Manual
Viewing Menu
Description:
This function returns a status value reporting the existence of a named view.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the distance will be obtained. If this value is set to
nothing or , the current view will be used.
Output:
INTEGER view_status This value returns the status of the named view as 1
or TRUE if it exists, and 0 or false if it does not exist.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_exist_get (p. 145) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 199
Viewing Menu
Description:
This function will get the field of view angle for the named view.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the field of view angle will be obtained. If this value is
set to nothing or , the current view will be used.
Output:
REAL fov_angle This value returns the field of view angle for the named
view.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
Remarks:
None
Example:
Please see ga_view_fov_get (p. 146) in the PCL Reference Manual Examples.
200 PCL Reference Manual
Viewing Menu
ga_view_fov_set (fov_angle)
Description:
This function will set the field of view angle for the current view.
Input:
REAL fov_angle This value specifies the field of view angle.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_fov_set (p. 147) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 201
Viewing Menu
Description:
This function will get the position of the observer.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the position of the observer will be obtained. If this
value is set to nothing or , the current view will be
used.
Output:
REAL position(3) This value returns the location of the position of the
observer. The offsets of the array (1, 2, 3) correspond
to the axes of the global model coordinate system (x,
y, z).
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
Remarks:
None
Example:
Please see ga_view_from_get (p. 148) in the PCL Reference Manual Examples.
202 PCL Reference Manual
Viewing Menu
ga_view_from_set (position)
Description:
This function will set the position of the observer in the current view.
Input:
REAL point(3) This value specifies the position of the observer. The
offsets of the array (1, 2, 3) correspond to the axes of
the global model coordinate system (x, y, z).
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
This function is identical to ga_view_to_set, 218.
Example:
Please see ga_view_from_set (p. 149) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 203
Viewing Menu
Description:
The function will get the distance from the center of the named view to the front clipping plane along
the z axis of the global model coordinate system.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the distance of the front clipping plane will be
obtained. If this value is set to nothing or , the
current view will be used.
Output:
REAL distance This value returns the distance from the center of the
named view to the front clipping plane. The output
value distance will always be greater than the
distance to the back clipping plane.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
Remarks:
None
Example:
Please see ga_view_front_get (p. 150) in the PCL Reference Manual Examples.
204 PCL Reference Manual
Viewing Menu
ga_view_front_set (distance)
Description:
This function will set the distance from the center of the named view to the front clipping plane along
the z axis of the global model coordinate system.
Input:
REAL distance This value specifies the distance from the center of
the named view to the front clipping plane. This
value must always be greater than the distance to the
back clipping plane.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_front_set (p. 151) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 205
Viewing Menu
Description:
This function gets the model scale factors for each of the axes in the global model coordinate system
of the named view.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the model scale factors will be obtained. If this value is
set to nothing or , the current view will be used.
Output:
REAL scale_x This value returns the scale factor for the x axis.
REAL scale_y This value returns the scale factor for the y axis.
REAL scale_z This value returns the scale factor for the z axis.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
Remarks:
None
Example:
Please see ga_view_model_scale_get (p. 152) in the PCL Reference Manual Examples.
206 PCL Reference Manual
Viewing Menu
Description:
This function sets the model scale factors for each of the axes in the global model coordinate system
of the current view.
Input:
REAL scale_x This value specifies the scale factor for the x axis.
REAL scale_y This value specifies the scale factor for the y axis.
REAL scale_z This value specifies the scale factor for the z axis.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_model_scale_set (p. 153) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 207
Viewing Menu
ga_view_nviews_get (number_of_views)
Description:
This function gets the number of views.
Input:
None.
Output:
INTEGER number_of_views This value returns the number of views.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000098 A fatal error has occurred in the database. Database is corrupted.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000085 Cursor not open
Remarks:
None
Example:
Please see ga_view_nviews_get (p. 154) in the PCL Reference Manual Examples.
208 PCL Reference Manual
Viewing Menu
Description:
This function gets the on/off status of the perspective for the name view.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the perspective status will be obtained. If this value is
set to nothing or , the current view will be used.
Output:
LOGICAL perspective_status This value returns the status of the perspective. It will
either be set to on (TRUE), or off (FALSE).
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
Remarks:
None
Example:
Please see ga_view_perspective_get (p. 155) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 209
Viewing Menu
ga_view_perspective_set (perspective_status)
Description:
This function sets the on/off status of the perspective for the current view.
Input:
LOGICAL perspective_status This value specifies the status of the perspective to
be either TRUE for on, or FALSE for off.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_perspective_set (p. 156) in the PCL Reference Manual Examples.
210 PCL Reference Manual
Viewing Menu
Description:
This function set a plane defined by three input points in the global model coordinate system as the
current view plane in the current view.
Input:
REAL point_1(3) This value specifies the first point defining a plane.
REAL point_2(3) This value specifies the second point defining a
plane.
REAL point_3(3) This value specifies the third point defining a plane.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
The offsets of the input point arrays (1, 2, 3) correspond to the axes of the global model coordinate system
(x, y, z).
Example:
Please see ga_view_plane_set (p. 158) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 211
Viewing Menu
Description:
This function renames a view.
Input:
STRING original_name[31] This value specifies the original name of the view. If
this value is set to nothing or , the current view will
be used.
STRING new_name[31] This value specifies a new name to be assigned to the
view.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000153 The specified Named View already exists.
13000007 An unspecified database error occurred
Remarks:
If the new name already exists, the name of the view will not be changed.
Example:
Please see ga_view_rename (p. 159) in the PCL Reference Manual Examples.
212 PCL Reference Manual
Viewing Menu
Description:
This function gets the absolute x, y, and z angles of rotation around the axes of the global screen
coordinate system of the specified view.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the absolute angles will be obtained. If this value is
set to nothing or , the current view will be used.
Output:
REAL angle_x This value returns the rotation about the x axis.
REAL angle_y This value returns the rotation about the y axis.
REAL angle_z This value returns the rotation about the z axis.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
Remarks:
None
Example:
Please see ga_view_sa_get (p. 160) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 213
Viewing Menu
Description:
This function sets the absolute x, y, and z angles of rotation around the axes of the global screen
coordinate system for the current view.
Input:
REAL angle_x This value specifies the angle of rotation for the x axis.
REAL angle_y This value specifies the angle of rotation for the y axis.
REAL angle_z This value specifies the angle of rotation for the z axis.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000014 Viewport not found
Remarks:
None
Example:
Please see ga_view_sa_set (p. 161) in the PCL Reference Manual Examples.
214 PCL Reference Manual
Viewing Menu
Description:
This function gets the model scale factors for each of the axes in the global screen coordinate system
of the named view.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the screen scale factors will be obtained. If this value is
set to nothing or , the current view will be used.
Output:
REAL scale_x This value returns the scale factor for the x axis.
REAL scale_y This value returns the scale factor for the y axis.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
Remarks:
None
Example:
Please see ga_view_screen_scale_get (p. 162) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 215
Viewing Menu
Description:
This function sets the screen scale factors for each of the axes in the global screen coordinate system
of the current view.
Input:
REAL scale_x This value specifies the scale factor for the x axis.
REAL scale_y This value specifies the scale factor for the y axis.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_screen_scale_set (p. 163) in the PCL Reference Manual Examples.
216 PCL Reference Manual
Viewing Menu
Description:
This function sets the relative x, y, and z angles of rotation around the axes of the global screen
coordinate system for the current view.
Input:
REAL angle_x This value specifies the angle of rotation for the x axis.
REAL angle_y This value specifies the angle of rotation for the y axis.
REAL angle_z This value specifies the angle of rotation for the z axis.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000132 There is no current view.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None
Example:
Please see ga_view_sr_set (p. 164) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 217
Viewing Menu
Description:
This function returns the center point of the named view.
Input:
STRING name_of_view[31] This value specifies the name of the view from
which the center point will be obtained. If this value
is set to nothing or , the current view will be used.
Output:
REAL center_point(3) This value returns the location of the center point of
the view. The offsets of the array (1, 2, 3) correspond
to the axes of the global model coordinate system (x,
y, z).
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000132 There is no current view.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
Remarks:
None
Example:
Please see ga_view_to_get (p. 166) in the PCL Reference Manual Examples.
218 PCL Reference Manual
Viewing Menu
ga_view_to_set (point)
Description:
This function will set the position of the observer in the current view.
Input:
REAL point(3) This value sets the position of the observer. The
offsets of the array (1, 2, 3) correspond to the axes of
the global model coordinate system (x, y, z).
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
This function is identical to the function ga_view_from_set.
Example:
Please see ga_view_to_set (p. 167) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 219
Viewing Menu
Description:
This function returns a point that is on a vector normal to the view plane of the named view that defines
the up direction of the view.
Input:
STRING name_of_view[31] This value specifies the name of the view from which
the direction vector will be obtained. If this value is set
to nothing or , the current view will be used.
Output:
REAL direction_vector(3) This value returns the location of a point on a vector
normal to the view plane defining the up direction of
the view. The offsets of the array (1, 2, 3) correspond
to the axes of the global model coordinate system (x, y,
z).
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
Remarks:
None
Example:
Please see ga_view_up_get (p. 168) in the PCL Reference Manual Examples.
220 PCL Reference Manual
Viewing Menu
ga_view_up_set (direction_vector)
Description:
This function defines the up direction in a view by setting a point that is on a vector normal to the
view plane of the current view.
Input:
REAL direction_vector(3) This value specifies the location of a point on a
vector normal to the view plane defining the up
direction of the view. The offsets of the array (1, 2,
3) correspond to the axes of the global model
coordinate system (x, y, z).
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000013 View not found
Remarks:
None
Example:
Please see ga_view_up_set (p. 169) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 221
Viewing Menu
ga_view_views_get (view_list)
Description:
This function gets a list of all of the named views.
Input:
None.
Output:
STRING view_list[31]() This value returns a list of all of the view. The number
of offsets allocated for this array should match the
number of viewports. See the remarks below for more
information.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000098 A fatal error has occurred in the database. Database is corrupted.
13000085 Cursor not open
Remarks:
The number of viewports can be found through a call to the function ga_viewport_view_get.
Example:
Please see ga_view_views_get (p. 170) in the PCL Reference Manual Examples.
222 PCL Reference Manual
Viewing Menu
Description:
This function will get the zoom factor for the named view.
Input:
STRING name_of_view[31] This value specifies the name of the view from
which the zoom factor will be obtained. If this value
is set to nothing or , the current view will be used.
Output:
REAL zoom_factor This value returns the zoom factor for the named
view.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000058 The view name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
Remarks:
None
Example:
Please see ga_view_zoom_get (p. 171) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 223
Viewing Menu
ga_view_zoom_set (zoom_factor)
Description:
This function will set the current zoom factor for the current view.
Input:
REAL zoom_factor This value specifies the new zoom factor to which
the current view will be set. The zoom factor value
must be between 1e-32 and 1e+32 or otherwise
function will return an error.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000103 The specified view was not found in the data base.
11000132 There is no current view.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_view_zoom_set (p. 172) in the PCL Reference Manual Examples.
224 PCL Reference Manual
Viewport Menu
Viewport Menu
This section is used to describe functions that are used to create, delete, modify and retrieve the settings
of named viewports.
A viewport is a named graphics window in which portions of a models geometry, finite elements, and
analysis results are displayed. The data that defines a viewport is stored in the database. The viewport
will display several pieces of information in its title bar: the name of the model database, the viewport
name, the current group name, and the display method. The following functions can be used to change,
create, and delete viewports and many of the attributes associated with them.
Each of these functions modify and/or retrieve information from the database. The act of posting a
viewport or an attribute of a viewport will set that viewport or attribute as being selected for display and
will cause the display to be updated as needed.
Description:
This function will return a value from the database indicating if a coordinate axis should be displayed
in a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport.
Output:
INTEGER axis_display This value returns the status of the coordinate axis
display in the viewport. It will be set to TRUE or 1
if the coordinate axis should be displayed and
FALSE or 0 if it should not.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
13000004 GaErrDuplicate entry exists in table
13000007 An unspecified database error occurred
13000014 Viewport not found
Chapter 2: Basic Functions 225
Viewport Menu
Remarks:
If the input value viewport_name is set to nothing or , the current viewport is used.
Example:
Please see ga_viewport_axis_get (p. 81) in the PCL Reference Manual Examples.
Description:
This function will set a value in the database used to indicate if a coordinate axis display should be
shown in the viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport.
INTEGER axis_display This value should be set to TRUE or 1 if the coordinate
axis should be displayed and FALSE or 0 if it should
not.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
13000004 GaErrDuplicate entry exists in table
13000007 An unspecified database error occurred
13000014 Viewport not found
Remarks:
If the input value viewport_name is set to nothing or , the current viewport is used.
Example:
Please see ga_viewport_axis_set (p. 82) in the PCL Reference Manual Examples.
226 PCL Reference Manual
Viewport Menu
Description:
This function will get the background color of a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport.
Output:
INTEGER background_color This value returns the background color for the viewport.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
13000004 GaErrDuplicate entry exists in table
13000007 An unspecified database error occurred
13000014 Viewport not found
Remarks:
If the input value viewport_name is set to nothing or , the current viewport is used.
Example:
Please see ga_viewport_background_get (p. 83) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 227
Viewport Menu
Description:
This function will set and post the background color of a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport.
INTEGER background_color This value specifies the background color for the
viewport.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
13000004 GaErrDuplicate entry exists in table
13000007 An unspecified database error occurred
13000014 Viewport not found
Remarks:
If the input value viewport_name is set to nothing or , the current viewport is used.
Example:
Please see ga_viewport_background_set (p. 84) in the PCL Reference Manual Examples.
228 PCL Reference Manual
Viewport Menu
Description:
This function will create, set the active group to the current group, make current, and post a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport.
REAL x_location This value specifies the X axis location of the
upper left corner of the viewport relative to the
upper left corner of the screen.
REAL y_location This value specifies the Y axis location of the
upper left corner of the viewport relative to the
upper left corner of the screen.
REAL width This value specifies the width of the viewport.
REAL height This value specifies the height of the viewport.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000006 A viewport with the given name is already in the database.
11000007 The viewport name is invalid.
11000008 The location of the viewport is out of range
11000009 The size of the viewport is out of range
11000097 There is not enough disk space to complete operation.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000013 View not found
Remarks:
An input value viewport_name value of nothing or is not allowed and will return an error.
The input values x_location, y_location, width, and height must all be positive.
Chapter 2: Basic Functions 229
Viewport Menu
Example:
Please see ga_viewport_create (p. 85) in the PCL Reference Manual Examples.
ga_viewport_current_get (viewport_name)
Description:
This function will get the name of the current viewport.
Input:
None.
Output:
STRING viewport_name[31] This value returns the name of the current viewport.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000014 Viewport not found
Remarks:
None.
Example:
Please see ga_viewport_current_get (p. 87) in the PCL Reference Manual Examples.
230 PCL Reference Manual
Viewport Menu
ga_viewport_current_set (viewport_name)
Description:
This function will set the name of the current viewport.
Input:
STRING viewport_name[31] This value specifies the name of the current
viewport.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_viewport_current_set (p. 88) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 231
Viewport Menu
ga_viewport_delete (viewport_name)
Description:
This function deletes the named viewport.
Input:
STRING viewport_name[31] This value specify the name of the viewport to be
deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000095 The specified operation cannot be performed on the current viewport.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_viewport_delete (p. 89) in the PCL Reference Manual Examples.
232 PCL Reference Manual
Viewport Menu
Description:
This function can be used to find out if a viewport with a specified name exists.
Input:
STRING viewport_name[31] This value specifies the name of the viewport to be
checked for existence.
Output:
INTEGER existance_flag This value returns TRUE or 1 if the named viewport
exists, and FALSE or 0 if it does not.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000095 The specified operation cannot be performed on the current viewport.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_viewport_exist_get (p. 90) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 233
Viewport Menu
Description:
This function posts a group to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport to
which the group will be posted. If this value is set to
nothing or , the current viewport will be used.
STRING group_name[31] This value specifies the name of the group to be
posted. If this value is set to nothing or , the current
viewport will be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000050 The group name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000121 There is not a current group defined.
11000122 The group has already been posted to the viewport.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000008 Group not found
13000014 Viewport not found
Remarks:
None.
Example:
Please see ga_viewport_group_post (p. 91) in the PCL Reference Manual Examples.
234 PCL Reference Manual
Viewport Menu
ga_viewport_group_post_all (viewport_name)
Description:
This function posts all defined groups to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport to
which the group will be posted. If this value is set to
nothing or , the current viewport will be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
11000105 The specified group was not found in the database.
11000122 The group has already been posted to the viewport.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000008 Group not found
Remarks:
None.
Example:
Please see ga_viewport_group_post_all (p. 92) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 235
Viewport Menu
Description:
This function unposts a group from a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport to
which the group will be posted. If this value is set to
nothing or , the current viewport will be used.
STRING group_name[31] This value specifies the name of the group to be
unposted. If this value is set to nothing or , the
current viewport will be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000050 The group name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
11000105 The specified group was not found in the database.
11000121 There is not a current group defined.
11000122 The group has already been posted to the viewport.
11000124 Group cannot be unposted from viewport not posted to.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000008 Group not found
13000014 Viewport not found
Remarks:
None.
Example:
Please see ga_viewport_group_unpost (p. 93) in the PCL Reference Manual Examples.
236 PCL Reference Manual
Viewport Menu
ga_viewport_group_unpost_all (viewport_name)
Description:
This function will unpost all posted groups from a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport to
which the group will be unposted. If this value is set
to nothing or , the current viewport will be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000100 The specified viewport was not found in the database.
11000105 The specified group was not found in the database.
11000125 The viewport has no groups posted to it.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000008 Group not found
Remarks:
None.
Example:
Please see ga_viewport_group_unpost_all (p. 94) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 237
Viewport Menu
Description:
This function gets the groups posted to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the group list will be made. If this value is set
to nothing or , the current viewport will be used.
Output:
STRING group_list[31]() This value returns a list of group names posted to the
viewport. The number of offsets allocated for this
array should match the number of groups posted to
this viewport. See the remarks below for more
information.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
11000114 There are no groups posted to the viewport.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000008 Group not found
13000085 Cursor not open
Remarks:
The number of groups posted to this viewport can be obtained through a call to the function
ga_viewport_ngroups_get.
Example:
Please see ga_viewport_groups_get (p. 95) in the PCL Reference Manual Examples.
238 PCL Reference Manual
Viewport Menu
Description:
This function posts a light source to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport to
which the light source will be posted. If this value is
set to nothing or , the current viewport will be
used.
STRING light[31] This value specifies the name of a light source.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000036 A light source with the given name is already in the database.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000104 The specified light source was not found in the database.
13000010 Light source not found
13000014 Viewport not found
Remarks:
Currently, this function does nothing.
Example:
Please see ga_viewport_light_post (p. 95) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 239
Viewport Menu
Description:
This function unposts a light source from a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport to
which the light source will be unposted. If this value
is set to nothing or , the current viewport will be
used.
STRING light[31] This value specifies the name of a light source.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000036 A light source with the given name is already in the database.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000104 The specified light source was not found in the database.
13000010 Light source not found
13000014 Viewport not found
Remarks:
Currently, this function does nothing.
Example:
Please see ga_viewport_light_unpost (p. 97) in the PCL Reference Manual Examples.
240 PCL Reference Manual
Viewport Menu
Description:
This function gets a list of light source names posted to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the list of light sources will be made. If this
value is set to nothing or , the current viewport will
be used.
Output:
STRING light_list[31]() This value returns a list of light source names posted
to the viewport. The number of offsets allocated for
this array should match the number of light sources
posted to this viewport. See the remarks below for
more information.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
11000113 There are no light sources posted to the viewport.
13000014 Viewport not found
Remarks:
The number of light source names currently posted to a viewport can be found through a call to the
function ga_viewport_nlights_get.
Currently, this function does nothing to the contents of the input value light_list.
Example:
Please see ga_viewport_lights_get (p. 98) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 241
Viewport Menu
ga_viewport_location_get (viewport_name, x, y)
Description:
This function gets the viewport location relative to the upper left corner of the parent graphics window.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the location will be retrieved. If this value is
set to nothing or , the current viewport will be
used.
Output:
REAL x This value returns the viewport X position.
REAL y This value returns the viewport Y position.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
13000014 Viewport not found
Remarks:
None.
Example:
Please see ga_viewport_location_get (p. 99) in the PCL Reference Manual Examples.
242 PCL Reference Manual
Viewport Menu
Description:
This function sets and optionally posts the viewport location relative to the upper left corner of the
parent graphics window.
Input:
STRING viewport_name[31] This value specifies the name of the viewport that
will have its location set. If this value is set to
nothing or , the current viewport will be used.
REAL x This value specifies the viewport X position and it
must be a positive number.
REAL y This value specifies the viewport Y position and it
must be a positive number.
INTEGER update_control This value specifies the method used to update or
post the display with the new location information.
When this value is set to 1 or TRUE, the viewport
will be updated immediately. If the this value is set
to 0 or FALSE, updating the viewport will be
deferred until another graphics manager event takes
place. It is recommended that this value always be
set to 1 or TRUE.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000008 The location of the viewport is out of range
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
None.
Example:
Please see ga_viewport_location_set (p. 100) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 243
Viewport Menu
Description:
This function will get the number of groups posted to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the number of groups assigned to the viewport
will be obtained. If this value is set to nothing or ,
the current viewport will be used.
Output:
INTEGER number_of_groups This value returns the number of groups assigned to
a viewport.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000100 The specified viewport was not found in the database.
11000098 A fatal error has occurred in the database. Database is corrupted.
Remarks:
None.
Example:
Please see ga_viewport_ngroups_get (p. 102) in the PCL Reference Manual Examples.
244 PCL Reference Manual
Viewport Menu
Description:
This function will get the number of lights posted to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the number of light sources assigned to the
viewport will be obtained. If this value is set to
nothing or , the current viewport will be used.
Output:
INTEGER number_of_lights This value returns the number of light sources
assigned to a viewport.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
Currently, this function does nothing and will not modify the initial value of the output value
number_of_lights.
Example:
Please see ga_viewport_nlights_get (p. 102) in the PCL Reference Manual Examples
Chapter 2: Basic Functions 245
Viewport Menu
ga_viewport_nposted_get (number_of_viewports)
Description:
This function will get the number of viewports that have been marked as posted.
Input:
None.
Output:
INTEGER number_of_viewports This value returns the number of posted viewports.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000098 A fatal error has occurred in the database. Database is corrupted.
Remarks:
None.
Example:
Please see ga_viewport_nposted_get (p. 104) in the PCL Reference Manual Examples.
246 PCL Reference Manual
Viewport Menu
ga_viewport_nviewports_get (number_of_viewports)
Description:
This function will get the number of viewports that have been defined in the database.
Input:
None.
Output:
INTEGER number_of_viewports This value returns the number of viewports.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000098 A fatal error has occurred in the database. Database is corrupted.
Remarks:
None.
Example:
Please see ga_viewport_nviewports_get (p. 105) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 247
Viewport Menu
Description:
This function will get the status of a value used to state if a symbol should be displayed at the origin of
the global coordinate system for a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport that
will be checked for the state of the origin symbol. If
this value is set to nothing or , the current viewport
will be used.
Output:
INTEGER origin_status This value returns the status value used to indicate if
a coordinate system origin symbol should be
displayed. This value will be set to 1 or TRUE if the
coordinate system origin should be displayed, 0 or
FALSE if it should not be displayed.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
13000014 Viewport not found
Remarks:
None.
Example:
Please see ga_viewport_origin_get (p. 106) in the PCL Reference Manual Examples.
248 PCL Reference Manual
Viewport Menu
Description:
This function will set and post the status of a value used to state if a symbol should be displayed at the
origin of the global coordinate system for a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport that
will have its coordinate system origin state set. If this
value is set to nothing or , the current viewport will
be used.
INTEGER origin_status This value specifies the status value used to indicate
if a coordinate system origin symbol should be
displayed. This value should be set to either 1 or
TRUE if the coordinate system origin should be
displayed, or 0 or FALSE if it should not.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
13000014 Viewport not found
Remarks:
None.
Example:
Please see ga_viewport_origin_set (p. 107) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 249
Viewport Menu
ga_viewport_post (viewport_name)
Description:
This function will post a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport that
will have its coordinate system origin state set. If this
value is set to nothing or , the current viewport will
be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
13000014 Viewport not found
Remarks:
None.
Example:
Please see ga_viewport_post (p. 108) in the PCL Reference Manual Examples.
250 PCL Reference Manual
Viewport Menu
ga_viewport_posted_get (viewport_list)
Description:
This function will get a list of all of the posted viewports.
Input:
None.
Output:
STRING viewport_list[31]() This value returns a list of all of the posted
viewports. The number of offsets allocated for this
array should match the number of posted viewports.
See the remarks below for more information.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
The number of posted viewports can be found through a call to the function ga_viewport_nposted_get.
Example:
Please see ga_viewport_posted_get (p. 109) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 251
Viewport Menu
Description:
This function will get the name of the range of numeric values used in conjunction with spectrums for
displaying results posted to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the range assigned to the viewport will be
obtained. If this value is set to nothing or , the
current viewport will be used.
Output:
STRING range[31] This value returns the name of the range posted to
the specified viewport.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
None.
Example:
Please see ga_viewport_range_get (p. 110) in the PCL Reference Manual Examples.
252 PCL Reference Manual
Viewport Menu
Description:
This function will set and post the name of the range of numeric values used in conjunction with
spectrums for displaying results to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the range assigned to the viewport will be
obtained. If this value is set to nothing or , the
current viewport will be used.
STRING range[31] This value specifies the name of the range that will
be set and posted to the viewport. If this value is set
to nothing or , the current range will be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
None.
Example:
Please see ga_viewport_range_set (p. 111) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 253
Viewport Menu
Description:
This function will rename a viewport.
Input:
STRING original_name[31] This value specifies the original name of the
viewport. Setting this value to nothing or to
identify the current viewport does not work here and
will generate an error.
STRING new_name[31] This value specifies the new viewport name.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
None.
Example:
Please see ga_viewport_rename (p. 112) in the PCL Reference Manual Examples.
254 PCL Reference Manual
Viewport Menu
Description:
This function gets the width and height of a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the height and width will be obtained. If this
value is set to nothing or , the current viewport will
be used.
Output:
REAL width This value returns the viewport width.
REAL height This value returns the viewport height.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
None.
Example:
Please see ga_viewport_size_get (p. 113) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 255
Viewport Menu
Description:
This function sets the width and height of a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the height and width will be obtained. If this
value is set to nothing or , the current viewport will
be used.
REAL width This value specifies the width of the viewport and
must be greater than or equal to 1.0.
REAL height This value specifies the height of the viewport and
must be greater than or equal to 1.0.
INTEGER update_control This value specifies the method used to update or
post the display with the new size information.
When this value is set to 1 or TRUE, the viewport
will be updated immediately. If the this value is set
to 0 or FALSE, updating the viewport will be
deferred until another graphics manager event takes
place. It is recommended that this value always be
set to 1 or TRUE.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000009 The size of the viewport is out of range.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
None.
Example:
Please see ga_viewport_size_set (p. 114) in the PCL Reference Manual Examples.
256 PCL Reference Manual
Viewport Menu
Description:
This function gets the current value of an integer intended to be used to record the posting status of the
current spectrum for a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the posting status of the current spectrum will
be obtained. If this value is set to nothing or , the
current viewport will be used.
Output:
INTEGER spectrum_status This value returns the status of the integer intended
for use in recording the posting status of the current
spectrum to a viewport.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
None.
Example:
Please see ga_viewport_spectrum_get (p. 116) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 257
Viewport Menu
Description:
This function sets the posting status of the current spectrum and the legend for a viewport.
Input:
STRING viewport_name[31] This value specifies the name of viewport to which
the current spectrum will be posted. If this value is
set to nothing or , the current viewport will be
used.
INTEGER spectrum_status This value specifies the status of current spectrum
and the legend for viewport. The possible integer
values and their corresponding status are:
0 - No Spectrum, No Legend
1 - Spectrum, No Legend
2 - No Spectrum, Legend
3 - Spectrum, Legend
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
None.
Example:
Please see ga_viewport_spectrum_set (p. 117) in the PCL Reference Manual Examples.
258 PCL Reference Manual
Viewport Menu
Description:
This function will post a title to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the title will be posted. If this value is set to
nothing or , the current viewport will be used.
STRING title[256] This value specifies the title that will be posted to the
viewport.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
13000004 Duplicate entry exists in table
13000014 Viewport not found
13000135 The specified VP title was not found.
Remarks:
None.
Example:
Please see ga_viewport_title_post (p. 118) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 259
Viewport Menu
Description:
This function will unpost a title from a viewport and delete the title from the database.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the title will be unposted. If this value is set to
nothing or , the current viewport will be used.
STRING title[256] This value specifies the title that will be unposted
from the viewport.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
13000014 Viewport not found
13000135 The specified VP title was not found.
Remarks:
None.
Example:
Please see ga_viewport_title_unpost (p. 119) in the PCL Reference Manual Examples.
260 PCL Reference Manual
Viewport Menu
ga_viewport_unpost (viewport_name)
Description:
This function will unpost a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport that
will be marked as unposted. If this value is set to
nothing or , the current viewport will be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
Remarks:
None.
Example:
Please see ga_viewport_unpost (p. 121) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 261
Viewport Menu
Description:
This function will assign a view name to the current view parameters of a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the current view parameters will be obtained.
If this value is set to nothing or , the current
viewport will be used.
STRING name_of_view[31] This value specifies the name of the view to which
the current view parameters of the viewport will be
assigned.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000058 The view name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
11000103 The specified view was not found in the data base.
Remarks:
This function is a little different as it is named in a manner that suggests that it should return information
retrieved from the database in an output argument. Instead of returning information in an output
argument, this function retrieves information about a viewport from the database and then assigns a view
name to that information in the database.
See the listing for this function in Broken, Obsolete, Modified and New Functions for further information.
Example:
Please see ga_viewport_view_get (p. 122) in the PCL Reference Manual Examples.
262 PCL Reference Manual
Viewport Menu
Description:
This function will get the name of the view of a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport from
which the name of the view will be obtained. If this
value is set to nothing or , the current viewport will
be used.
Output:
STRING name_of_view[31] This value returns the name of the view for the
specified viewport.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000096 A current viewport has not been defined.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
11000116 No view has been assigned to the viewport.
Remarks:
See the listing for this function in Broken, Obsolete, Modified and New Functions for further information.
Example:
Please see ga_viewport_view_name (p. 123) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 263
Viewport Menu
Description:
This function will post a view to a viewport.
Input:
STRING viewport_name[31] This value specifies the name of the viewport to
which the view will be posted. If this value is set to
nothing or , the current viewport will be used.
STRING name_of_view[31] This value specifies the name of the view that will be
posted to the viewport. If this value is set to nothing
or , the current view will be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000007 The viewport name is invalid.
11000058 The view name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000100 The specified viewport was not found in the database.
11000103 The specified view was not found in the data base.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000013 View not found
Remarks:
None.
Example:
Please see ga_viewport_view_set (p. 123) in the PCL Reference Manual Examples.
264 PCL Reference Manual
Viewport Menu
ga_viewport_viewports_get (viewport_list)
Description:
This function gets a list of all of the viewports, including viewports that have not been posted.
Input:
None.
Output:
STRING viewport_list[31]() This value returns a list of all of the viewports. The
number of offsets allocated for this array should
match the number of viewports. See the remarks
below for more information.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000098 A fatal error has occurred in the database. Database is corrupted.
Remarks:
The number of viewports can be found through a call to the function ga_viewport_nviewports_get.
Example:
Please see ga_viewport_viewports_get (p. 125) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 265
Display Menu
Display Menu
Chapter 2: Basic Functions
This section is used to describe functions that are used to control the values stored in the database that
govern what and how geometric and finite element model entities are displayed in a viewport.
Description:
This function gets the subdivision tolerance value used in conjunction with setting the ranges for
spectrums used to display results.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
REAL tolerance This value returns the range subdivision tolerance
value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000016 Display not found
Remarks:
None.
Example:
Please see ga_display_autosubdivconst_get (p. 174) in the PCL Reference Manual Examples.
266 PCL Reference Manual
Display Menu
Description:
This function sets the subdivision tolerance value used in conjunction with setting the ranges for
spectrums used to display results.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
REAL tolerance This value specifies the range subdivision tolerance
value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_autosubdivconst_set (p. 175) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 267
Display Menu
Description:
This function gets the status of the autosubdivide flag used in storing the value of a setting for the range
used with spectrums used to display results.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER autosubdivide_status This value returns the autosubdivide and can be any
value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_autosubdivide_get (p. 177) in the PCL Reference Manual Examples.
268 PCL Reference Manual
Display Menu
Description:
This function sets the status of the autosubdivide flag used in storing the value of a setting for the range
used with spectrums to display results.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER autosubdivide_status This value specifies the autosubdivide status and can
be set to any value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_autosubdivide_set (p. 178) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 269
Display Menu
Description:
This function gets the status of the value used to control the display of back facing polygons.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER backface_status This value returns the status for the display of back
facing polygons. This argument may be set to any
value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_backfacing_get (p. 179) in the PCL Reference Manual Examples.
270 PCL Reference Manual
Display Menu
Description:
This function sets the value used to control the display of back facing polygons.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER backface_status This value specifies the status for the display of back
facing polygons. It can be set to any value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_backfacing_set (p. 181) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 271
Display Menu
Description:
This function gets the bump map parameters for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER bump_map_id This value returns the bump map ID.
INTEGER bump_map_number This value returns the number of bump maps per
surface.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_bumpmap_get (p. 182) in the PCL Reference Manual Examples.
272 PCL Reference Manual
Display Menu
Description:
This function sets the bump map parameters for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER bump_map_id This value specifies the ID number identifying a
specific bump map.
INTEGER bump_map_number This value specifies the number of bump maps per
surface.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_bumpmap_set (p. 183) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 273
Display Menu
Description:
This function gets the label spacing for contour plots from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER label_spacing This value returns the label spacing for contour
plots. This value will always be greater than zero.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_contour_lblspcng_get (p. 185) in the PCL Reference Manual Examples.
274 PCL Reference Manual
Display Menu
Description:
This function sets the label spacing for contour plots for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER label_spacing This value specifies the label spacing for contour
plots. This value must be greater than zero or an error
condition will be returned.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000091 The specified contour label spacing is not valid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_contour_lblspcng_set (p. 186) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 275
Display Menu
ga_display_create (display_name)
Description:
This function will create a named display property list using display property list assigned the current
group for its default values.
Input:
STRING display_name[31] This value specifies the name of the display property list
to be created.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000041 A display property list with the given name is already in the database.
11000042 The display property list is invalid.
11000097 There is not enough disk space to complete operation.
11000098 A fatal error has occurred in the database. Database is corrupted.
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_create (p. 187) in the PCL Reference Manual Examples.
276 PCL Reference Manual
Display Menu
Description:
This function gets the deformation scale for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
REAL deformation_scale This value returns the deformation scale value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_deform_scale_get (p. 188) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 277
Display Menu
Description:
This function sets the deformation scale for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
REAL deformation_scale This value specifies the deformation scale for the
named display property list.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_deform_scale_set (p. 190) in the PCL Reference Manual Examples.
278 PCL Reference Manual
Display Menu
Description:
This function gets the interpretation of the deformation scale for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
STRING interpretation[31] This value returns the deformation scale interpretation
string which can have a value of either VALUE, or
PERCENTAGE.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_deform_scalintrp_get (p. 191) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 279
Display Menu
Description:
This function will set the interpretation value for the deformed entity scale for the named display
property list.
Input:
STRING display_name[31] This value specifies the name of the display property list
to which the requested data value will be set.
STRING interpretation[31] This value specifies the interpretation value. This string
can have either be set to VALUE or PERCENTAGE.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000093 The specified deform scale interpretation is not valid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_deform_scalintrp_set (p. 192) in the PCL Reference Manual Examples.
280 PCL Reference Manual
Display Menu
ga_display_delete (display_name)
Description:
This function will delete the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
11000141 The Display Property is in use by the model or is assigned to a group.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_delete (p. 193) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 281
Display Menu
Description:
This function will get the diffuse reflectance value for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
REAL diffuse_reflectance This value returns the diffuse reflectance value for
the named display property list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_diffuse_get (p. 194) in the PCL Reference Manual Examples.
282 PCL Reference Manual
Display Menu
Description:
Set the diffuse reflectance.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
REAL diffuse_reflectance This value specifies the diffuse reflectance for the
named display property list.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_diffuse_set (p. 196) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 283
Display Menu
ga_display_displays_get (display_list)
Description:
This function will get a list of all of the defined named display property lists.
Input:
None.
Output:
STRING display_list[31]() This value returns a list of all defined display
property lists. See the remarks below for more
information.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000098 A fatal error has occurred in the database. Database is corrupted.
13000085 Cursor not open
Remarks:
The output value display_list must be allocated with enough offsets available to contain the entire list.
The number of offsets needed can be obtained through a call to the function ga_display_ndisplays_get.
Example:
Please see ga_display_displays_get (p. 197) in the PCL Reference Manual Examples.
284 PCL Reference Manual
Display Menu
Description:
This function will get the edge color attributes used in shading for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER color_index This value returns the color index for the edges of the
named display property list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_edgecolor_get (p. 198) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 285
Display Menu
Description:
This function will set the edge color attributes used in shading for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER color_index This value specifies the edge color attributes for the
named display property list.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_edgecolor_set (p. 199) in the PCL Reference Manual Examples.
286 PCL Reference Manual
Display Menu
Description:
This function is used to check for the existence of a named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER display_status This value returns the existence of the named display
property list. It will be set to 0 or FALSE if the list
does not exist and it will be set to 1 or TRUE if the
list exists.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_exist_get (p. 200) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 287
Display Menu
Description:
This function will get the free FEM characteristics display style attribute from the named display
property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER style This value returns the free FEM display style for the
named display property list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_freefem_get (p. 201) in the PCL Reference Manual Examples.
288 PCL Reference Manual
Display Menu
Description:
This function will set the free FEM characteristics display style attribute for the named display property
list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER style This value specifies the free FEM display style for
the named display property list.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_freefem_set (p. 203) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 289
Display Menu
Description:
This function will get the amount of glossiness for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
REAL gloss_value This value returns the gloss value for the named
display property list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_gloss_get (p. 204) in the PCL Reference Manual Examples.
290 PCL Reference Manual
Display Menu
Description:
This function will set the amount of gloss for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
REAL gloss_value This value specifies the gloss for the named display
property list.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_gloss_set (p. 206) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 291
Display Menu
Description:
This function gets the on/off status for the display of gravitational points for the named display property
list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER gravity_status This value returns the on/off status for the display of
gravitational points and can be of any value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_gravitation_get (p. 207) in the PCL Reference Manual Examples.
292 PCL Reference Manual
Display Menu
Description:
This function sets the on/off status for the display of gravitational points for the named display property
list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER gravity_status This value specifies the on/off status used to control
the display of gravitational points and can be of any
value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_gravitation_set (p. 208) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 293
Display Menu
Description:
This function will get the value used to control specular reflections for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER specular_value This value returns the state of the value used to
control specular reflections.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_hilight_get (p. 209) in the PCL Reference Manual Examples.
294 PCL Reference Manual
Display Menu
Description:
This function will set the value used to control specular reflections for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER specular_value This value specifies the state of the value used to
control specular reflections.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_hilight_set (p. 210) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 295
Display Menu
Description:
This function will get the label color for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER label_color This value returns the label color for the named
display property list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_labelcolor_get (p. 212) in the PCL Reference Manual Examples.
296 PCL Reference Manual
Display Menu
Description:
This function sets the label color for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER label_color This value specifies the label color.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_labelcolor_set (p. 213) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 297
Display Menu
Description:
This function gets the number of visualization lines from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER line_number This value returns the number of visualization lines.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_lines_get (p. 214) in the PCL Reference Manual Examples.
298 PCL Reference Manual
Display Menu
Description:
This function will set the number of visualization lines for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER line_number This value specifies the number of visualization
lines.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_lines_set (p. 216) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 299
Display Menu
Description:
This function will get the line style for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
STRING line_style[31] This value returns one of the two values, SOLID,
or DASHED, that are used to specify the line style.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_linestyle_get (p. 217) in the PCL Reference Manual Examples.
300 PCL Reference Manual
Display Menu
Description:
Set the curve style.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
STRING line_style[31] This value specifies the line_style and it should be
set to one of the two supported values: SOLID, or
DASHED. These two values are not case
sensitive.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000043 The specified line style is not valid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_linestyle_set (p. 218) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 301
Display Menu
Description:
This function will get the line width for the named display property list. See remarks below.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER line_width This value returns the line width for the named
display property list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
This function does nothing and does not modify the initial value of the input value line_width.
Example:
Please see ga_display_linewidth_get (p. 219) in the PCL Reference Manual Examples.
302 PCL Reference Manual
Display Menu
Description:
This function will set the line width for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER line_width This value specifies the line width for the named
display property list.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
This function does nothing and does not make any use of the input value line_width.
Example:
Please see ga_display_linewidth_set (p. 220) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 303
Display Menu
ga_display_ndisplays_get (number_of_displays)
Description:
This function will get the number of named display properties currently defined.
Input:
None.
Output:
INTEGER number_of_displays This value returns the number of display properties.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000098 A fatal error has occurred in the database. Database is corrupted.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000085 Cursor not open
Remarks:
None.
Example:
Please see ga_display_ndisplays_get (p. 221) in the PCL Reference Manual Examples.
304 PCL Reference Manual
Display Menu
ga_display_nlspc_get (display_name,
number_of_segments)
Description:
This function will get the number of line segments per curve for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER number_of_segments This value returns the number of line segments per
curve.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_nlspc_get (p. 222) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 305
Display Menu
ga_display_nlspc_set (display_name,
number_of_segments)
Description:
This function will set the number of line segments per curve for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER number_of_segments This value specifies the number of line segments per
curve.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_nlspc_set (p. 223) in the PCL Reference Manual Examples.
306 PCL Reference Manual
Display Menu
ga_display_nspe_get (display_name,
number_of_segments)
Description:
This function will get the number of line segments per edge for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER number_of_segments This argument returns the number of line segments
per edge.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_nspe_get (p. 225) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 307
Display Menu
ga_display_nspe_set (display_name,
number_of_segments)
Description:
This function will set the number of line segments per edge for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER number_of_segments This values specifies the number of line segments
per edge.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_nspe_set (p. 226) in the PCL Reference Manual Examples.
308 PCL Reference Manual
Display Menu
Description:
This function controls the on/off status of the offset for the display of element properties for the named
display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER offset_status This argument returns the on/off status of the offset
for the display of element properties. This argument
may be any of any value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_offsets_get (p. 228) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 309
Display Menu
Description:
This function will set the on/off status of the offset for the display of element properties for the named
display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER offset_status This value specifies the on/off status for the display
of element properties. This argument can be set to
any value.
Output:
Remarks:
None.
Example:
Please see ga_display_offsets_set (p. 230) in the PCL Reference Manual Examples.
310 PCL Reference Manual
Display Menu
Description:
This function gets the on/off status for the display of parametric directions for the named display
property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER parametric_status This value returns the on/off status for the display of
parametric directions. This argument can return any
value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_parametric_get (p. 231) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 311
Display Menu
Description:
This function will set the on/off status for the display of parametric directions for the named display
property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER parametric_status This values specifies the on/off status for the display
of parametric directions.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_parametric_set (p. 233) in the PCL Reference Manual Examples.
312 PCL Reference Manual
Display Menu
Description:
This function will rename the named display property list.
Input:
STRING original_name[] This value specifies the original name of the display
property list.
STRING new_name[] This value specifies the new name of the display
property list.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_rename (p. 234) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 313
Display Menu
Description:
This function will get the on/off status value for the named display property list that is used to control
the display of results labels.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER result_label_status This value returns the on/off status used to control
the display of results labels. This argument can
return any value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_result_label_get (p. 235) in the PCL Reference Manual Examples.
314 PCL Reference Manual
Display Menu
Description:
This function is used to set the on/off status value for the named display property list that is used to
control the display of results labels.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER result_label_status This value specifies the status value that controls the
display of results labels. This argument can be of any
value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_result_label_set (p. 236) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 315
Display Menu
Description:
This function will get the format value of the result labels for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
STRING label_format[31] This value returns the result label format value
which can be set to either LETTER or VALUE.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_result_lblformat_get (p. 238) in the PCL Reference Manual Examples.
316 PCL Reference Manual
Display Menu
Description:
This function will set the format value of the results labels for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
STRING label_format[31] This value specifies the result label format. This
argument can be set to a case insensitive value of
either LETTER, or VALUE.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000092 The specified result label format is not valid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_result_lblformat_set (p. 239) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 317
Display Menu
Description:
This function will get the on/off status of the value used to control the display of edges for the named
display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER edges_status This value returns the on/off status used to control
the display of edges. This argument can be of any
value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_showedges_get (p. 240) in the PCL Reference Manual Examples.
318 PCL Reference Manual
Display Menu
Description:
This function will set the on/off status of the value used to control the display of edges for the named
display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER edges_status This value specifies the on/off status used to control
the display of edges. This argument can be set to any
value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_showedges_set (p. 242) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 319
Display Menu
Description:
This function gets the shrink factor used in the display of finite elements for the named display property
list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
REAL shrink_factor This value returns the shrink factor.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_shrfem_get (p. 243) in the PCL Reference Manual Examples.
320 PCL Reference Manual
Display Menu
Description:
This function sets the shrink factor used in the display of finite elements for the named display property
list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
REAL shrink_factor This value specifies the shrink factor.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_shrfem_set (p. 244) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 321
Display Menu
Description:
This function will get the value used to turn the display of silhouettes on and off for the named display
property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER silhouette_status This value returns the value of used to control the
display of silhouettes. This argument can return any
value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_silhouette_get (p. 246) in the PCL Reference Manual Examples.
322 PCL Reference Manual
Display Menu
Description:
This function will set the value used to turn the display of silhouettes on and off for the named display
property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER silhouette_status This value specifies the status value used control the
display of silhouettes. This argument can be set to
any value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_silhouette_set (p. 247) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 323
Display Menu
Description:
This function will get the value used to control the color used for the shading of specular reflections
for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER color_value This value returns the value used to control the color
used for the shading of specular reflections. This
argument can have a value of 1, for the color of the
light, or 2, for the color of the object.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_specular_get (p. 249) in the PCL Reference Manual Examples.
324 PCL Reference Manual
Display Menu
Description:
This function will set the value used to control the color used for the shading of specular reflections for
the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER color_value This value specifies the color used for the shading of
specular reflections. This argument can be set to a
value of 1, for the color of light, or 2, for the color of
the object.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_specular_set (p. 250) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 325
Display Menu
Description:
This function will get the subdivision tolerance for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
REAL tolerance This value returns the subdivision tolerance.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_subdivision_get (p. 251) in the PCL Reference Manual Examples.
326 PCL Reference Manual
Display Menu
Description:
This function will set the subdivision tolerance for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
REAL tolerance This value specifies the subdivision tolerance value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_subdivision_set (p. 253) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 327
Display Menu
Description:
This function will get the texture value from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
REAL texture_value This value returns the texture value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_texture_get (p. 254) in the PCL Reference Manual Examples.
328 PCL Reference Manual
Display Menu
Description:
This function will set the texture value for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
REAL texture_value This value specifies the texture value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_texture_set (p. 256) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 329
Display Menu
Description:
This function will get the transparency level from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
REAL transparency_value This value returns the transparency level.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_transparency_get (p. 257) in the PCL Reference Manual Examples.
330 PCL Reference Manual
Display Menu
Description:
This function will set the transparency level for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
REAL transparency_value This value specifies the transparency value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_transparency_set (p. 258) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 331
Display Menu
Description:
This function will get the value of the color for undeformed entities from the named display property
list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER color_value This value returns the color value for undeformed
entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_color_get (p. 259) in the PCL Reference Manual Examples.
332 PCL Reference Manual
Display Menu
Description:
This function will set the value of the color for undeforned entities for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER color_value This value specifies the color used for the display of
undeformed entities.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_color_set (p. 260) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 333
Display Menu
Description:
This function will get the on/off status of the value used to control the display of undeformed entities
from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER undeform_status This value returns the status value used to control the
display of undeformed entities. This argument can
return any value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_get (p. 262) in the PCL Reference Manual Examples.
334 PCL Reference Manual
Display Menu
Description:
This function will set the on/off status of the value used to control the display of undeformed entities
for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER undeform_status This value specifies the on/off status used to control
the display of undeformed entities. The argument
can be set to any value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_set (p. 263) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 335
Display Menu
Description:
This function will get the value used to control the style used for the display of the lines that comprise
undeformed entities from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
STRING curve_style[31] This value returns the style used to display the lines
that comprise undeformed entities. This value will
be set to either SOLID, or DASHED.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_style_get (p. 264) in the PCL Reference Manual Examples.
336 PCL Reference Manual
Display Menu
Description:
This function will set the value used to control the style used for the display of the lines that comprise
undeformed entities for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
STRING curve_style[31] This value specifies the style used to display the
lines that comprise undeformed entities. The values
allowed for this string are SOLID, or DASHED.
This argument is not case sensitive.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000090 The specified undeformed entity style is not valid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_undeform_style_set (p. 265) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 337
Display Menu
Description:
This function will get the value for the color used to plot vectors from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER color_value This value returns the color used to plot vectors.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_color_get (p. 266) in the PCL Reference Manual Examples.
338 PCL Reference Manual
Display Menu
Description:
This function will set the value of the color used to plot vectors for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER color_value This value specifies the color used to plot vectors.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_color_set (p. 268) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 339
Display Menu
Description:
This function will get the style used to plot vectors from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
STRING vector_style[31] This value returns the style used to plot vectors. This
argument can return the values VALUE,
COMPONENT, or SPECTRUM.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_colorstyl_get (p. 269) in the PCL Reference Manual Examples.
340 PCL Reference Manual
Display Menu
Description:
This function will set the style used to plot vectors for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
STRING vector_style[31] This value specifies the style used to plot vectors.
This argument can a value of VALUE,
COMPONENT, or SPECTRUM.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000094 Message 11000094 not found in message file(s).
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_colorstyl_set (p. 270) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 341
Display Menu
Description:
This function will get the colors used to display functional assignment vectors from the named display
property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER color_value(5) This value returns the color values used to display
functional assignment vectors.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_facolor_get (p. 271) in the PCL Reference Manual Examples.
342 PCL Reference Manual
Display Menu
Description:
This function will set the values used to display functional assignment vectors for the named display
property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER color_value(5) This value specifies the color values used to display
functional assignment vectors.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_facolor_set (p. 272) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 343
Display Menu
Description:
This function will get the on/off status value used to control the display of labels for functional
assignment vectors from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER label_status This value returns the on/off status for the display of
functional assignment vector labels. This argument
can return any value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_falabel_get (p. 273) in the PCL Reference Manual Examples.
344 PCL Reference Manual
Display Menu
Description:
This function will set the on/off status value used to control the display of labels for functional
assignment vectors for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER label_status This value specifies the on/off status for the display
of function assignment vector labels. This argument
can be set to any value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_falabel_set (p. 275) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 345
Display Menu
Description:
This function will get the value used to control the length style of plotted vectors from the named
display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
STRING vector_style[31] This value returns the vector length style. This
argument will return the value
CONSTANT/SCREEN, SCALED/SCREEN,
CONSTANT/MODEL, or SCALED/MODEL.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_length_get (p. 276) in the PCL Reference Manual Examples.
346 PCL Reference Manual
Display Menu
Description:
This function will set the value used to control the length style of plotted vectors for the named display
property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
STRING vector_style[31] This value specifies the vector length style. This
argument can be set to the value
CONSTANT/SCREEN, SCALED_SCREEN,
CONSTANT/MODEL, or SCALED/MODEL.
The value of this argument is not case sensitive.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000094 Message 11000094 not found in message file(s).
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_length_set (p. 277) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 347
Display Menu
Description:
This function will get the on/off status value used to control the display of labels on results vectors from
the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER label_status This value returns the status value used to control the
display of labels on results vectors. This argument
can return any value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_reslabel_get (p. 278) in the PCL Reference Manual Examples.
348 PCL Reference Manual
Display Menu
Description:
This function will set the on/off status value used to control the display of labels on results vectors for
the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER label_status This value specifies the status of the value used to
control the display of labels on results vectors. This
argument can be set to any value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_reslabel_set (p. 279) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 349
Display Menu
Description:
This function will get the scale value used with vector plots from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
REAL vector_scale This value returns the scale value used with vector
plots.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_scale_get (p. 280) in the PCL Reference Manual Examples.
350 PCL Reference Manual
Display Menu
Description:
This function will set the scale value used with vector plots for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
REAL vector_scale This value specifies the scale value used with vector
plots.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector_scale_set (p. 282) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 351
Display Menu
Description:
This function will get the first vector component color from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER color_value This value returns the color value for the first vector
component.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector1_color_get (p. 283) in the PCL Reference Manual Examples.
352 PCL Reference Manual
Display Menu
Description:
This function will set the first vector component color for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER color_value This value specifies the color value for the first
vector component.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector1_color_set (p. 284) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 353
Display Menu
Description:
This function will get the second vector component color from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER color_value This value returns the color value for the second
vector component.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector2_color_get (p. 286) in the PCL Reference Manual Examples.
354 PCL Reference Manual
Display Menu
Description:
This function will set the second vector component color for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER color_value This value specifies the color value for the second
vector component.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector2_color_set (p. 287) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 355
Display Menu
Description:
This function will get the third vector component color from the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list from which the requested data value will be
obtained.
Output:
INTEGER color_value This value returns the color value for the third vector
component.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector3_color_get (p. 288) in the PCL Reference Manual Examples.
356 PCL Reference Manual
Display Menu
Description:
This function will set the third vector component color for the named display property list.
Input:
STRING display_name[31] This value specifies the name of the display property
list to which the requested data value will be set.
INTEGER color_value This value specifies the color value for the third
vector component.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
11000042 The display property list is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000107 The specified display property list was not found in the database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
Remarks:
None.
Example:
Please see ga_display_vector3_color_set (p. 290) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 357
Tools Menu
Tools Menu
This section is used to describe functions that used to create and manipulate lists and regions of geometric
and finite element model entities using the list processor and the list processor format. It is also used to
describe some of the functions that can be used to create and report the mass properties associated with
a model.
The list processing functions described below all make use of five global variables as a working or
scratch space: lista, lista_reset, listb, listb_reset, and listc. These variables are all global virtual string
variables whose length is manipulated with the aid of the sys_allocate_string() and
sys_reallocate_string() functions. They can be accessed directly if a declaration similar to the following
is made in a PCL source file:
GLOBAL STRING lista[VIRTUAL]
However, extreme care should be used in accessing or manipulating these values directly as they are
intended for internal use only and changing the contents of these strings can lead to unpredictable results.
list_create_boolean_list (blist_a,blist_b,btype,bret_list)
Description:
This function creates a list of entities by combining the contents of the global strings lista and listb
using the type of operation specified by the input value boolean and placing the results in the global
string listc.
Input:
STRING blist_a[] This value specifies the first string of entities to be
combined.
STRING blist_b[] This value specifies the second string of entities to
be combined.
STRING btype[7] This value specifies the type of operation to be used
to combine the first and second strings of entities.
See the remarks below for more information.
Output:
STRING bret_list[] This value returns the results of the specified
combination operation.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
48000002 *%A% * is not a valid boolean operator!
48000013 Boolean listc is empty!
358 PCL Reference Manual
Tools Menu
Remarks:
The input value btype can have the following values used to specify the different types of combinational
operations which combine the lists listed by the global string values lista and listb in the following
manner:
This function will display an information popup form if the boolean operation results in an single space
character string or if both of the input values blist_a and blist_b are set to some combination of either
or None. The information popup form will have the following message:
This function will display a warning popup form with the following message if the input value btype is
set to an invalid value:
This function calls the function fem_u_count_id() and will display a warning type popup form and return
the error value returned by this function if it has an error.
Space is internally allocated for the output value bret_list. It is the responsibility of the calling function
to free the allocated string storage space.
Example:
Please see list_create_boolean_list (p. 292) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 359
Tools Menu
Description:
This function will create a list of all curves from a list of geometric entities.
Input:
STRING entity_list[] This value specifies a list of geometric entities.
STRING target[6] This value specifies which global string will be used
for the storage of the results. This argument can have
the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of curves.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000049 LpParseExpression: Excess left parenthesis detected.
14000050 LpParseExpression: Excess right parenthesis detected.
14000281 LpExpandPclVariables: Virtual memory is full.
14000308 LpEval: Memory exhausted preparing to evaluate pick.
48000001 *%A% * is not a valid target list!
48000006 No Curve found!
360 PCL Reference Manual
Tools Menu
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
Description:
This function will create a list of all curves in a list of groups of geometric entities.
Input:
STRING group_list[](number_of_groups) This value specifies a list of groups of geometric
entities.
INTEGER number_of_groups This value specifies the number of groups in the
group_list input value.
STRING target[6] This value specifies which global string will be
used for the storage of the results. This
argument can have the following values: lista,
or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of curves.
Chapter 2: Basic Functions 361
Tools Menu
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
Description:
This function will create a list of all elements of a particular finite element model shape in a list of
geometric entities.
Input:
INTEGER element_shape_code This value specifies a code value used to select the
type of element shape to be used to make the returned
list of entities. See the remarks below for more
information.
STRING entity_list[] This value specifies a list of geometric entities.
STRING target[6] This value specifies which global string will be used
for the storage of the results. This argument can have
the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
Chapter 2: Basic Functions 363
Tools Menu
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000049 LpParseExpression: Excess left parenthesis detected.
14000050 LpParseExpression: Excess right parenthesis detected.
14000281 LpExpandPclVariables: Virtual memory is full.
14000308 LpEval: Memory exhausted preparing to evaluate pick.
48000001 *%A% * is not a valid target list!
48000003 No Element found!
Remarks:
The input value element_shape_code can have the following values:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
Description:
This function will create a list of all elements of a particular finite element model shape in a list of
groups of geometric entities.
Input:
INTEGER element_shape_code This value specifies a code value used to select
the type of element shape to be used to make the
returned list of entities. See the remarks below
for more information.
STRING group_list[](number_of_groups) This value specifies a list of groups of geometric
entities.
INTEGER number_of_groups This value specifies the number of groups in the
group_list input value.
STRING target[6] This value specifies which global string will be
used for the storage of the results. This
argument can have the following values: lista,
or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of elements.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8104003 Out of room in destination format string.
8107002 Last command aborted.
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000121 There is not a current group defined.
11000127 The group does not have any entities in it.
48000001 *%A% * is not a valid target list!
48000003 No Element found!
48000010 No Group selected!
366 PCL Reference Manual
Tools Menu
Remarks:
The input value element_shape_code can have the following values:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
list_create_elem_ass_node (element_shape_code,
node_list, target, return_list)
Description:
This function will create a list of all elements of a particular finite element model shape in a list of
nodes.
Input:
INTEGER element_shape_code This value specifies a code value used to select the
type of element shape to be used to make the
returned list of elements. See the remarks below for
more information.
STRING node_list[] This value specifies a list of nodes.
STRING target[6] This value specifies which global string will be used
for the storage of the results. This argument can have
the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1 This is an internal status condition. There is no corresponding status message in the
message database.
258 This is an internal status condition. There is no corresponding status message in the
message database.
259 This is an internal status condition. There is no corresponding status message in the
message database.
13000096 Not enough storage allocated for elements
14000004 LpSublistType: I am being invoked with a NULL list
48000001 *%A% * is not a valid target list!
48000003 No Element found!
368 PCL Reference Manual
Tools Menu
Remarks:
The input value element_shape_code can have the following values:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display a warning popup form with the following messages:
1 Not owner
13000096 Not enough storage allocated for elements
14000004 LpSublistType: I am being invoked with a NULL list
This function can display an information popup form with the following messages:
Description:
This function will create a list of all elements of a particular finite element model shape with a specified
fringe value in a single group of geometric entities.
Input:
INTEGER element_shape_code This value specifies a code value used to select the
type of element shape to be used to make the
returned list of entities. See the remarks below for
more information.
REAL fringe_limits(2) This value specifies the lower fringe limit as the
value in offset 1 and the upper fringe limit as the
value in offset 2.
STRING fringe_comparison_type[7] This value specifies the method that will be used for
comparing the fringe limits to the fringe value of the
element shape. See the remarks below for more
information.
REAL tolerance This value specifies a range over which a match
between the input value fringe_limits and the fringe
value for the finite element model shape can be
made.
STRING group_name[] This value specifies the name of a group of
geometric entities.
STRING target[6] This value specifies which global string will be used
for the storage of the results. This argument can have
the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
13000008 Group not found
1300002 Element not found
15500001 Message 15500001 not found in message file(s)
370 PCL Reference Manual
Tools Menu
Remarks:
The input value element_shape_code can have the following values:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
Chapter 2: Basic Functions 371
Tools Menu
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
Description:
This function will create a list of all elements of a particular finite element model shape from a list of
material names.
Input:
INTEGER element_shape_code This value specifies a code value used to select
the type of element shape to be used to make the
returned list of entities. See the remarks below for
more information.
STRING material_list[](num_materials) This value specifies a list of materials names.
INTEGER num_materials This value specifies the number of material
entries in the material_list input value.
STRING target[6] This value specifies which global string will be
used for the storage of the results. This argument
can have the following values: lista, or listb.
372 PCL Reference Manual
Tools Menu
Output:
STRING return_list[VIRTUAL] This value returns a list of elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-1 This is an internal status condition. There is no corresponding status message in the
message database.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000120 The material specified in the query was not found
48000001 *%A% * is not a valid target list!
48000003 No Element found!
Remarks:
The input value element_shape_code can have the following values:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
Description:
This function will create a list of all elements of a particular finite element model shape from a list of
property names.
Input:
INTEGER element_shape_code This value specifies a code value used to select the
type of element shape to be used to make the
returned list of entities. See the remarks below for
more information.
STRING properties_list[](num_proper This value specifies a list of property names.
ties)
INTEGER num_properties This value specifies the number of material entries in
the properties_list input value.
STRING target[6] This value specifies which global string will be used
for the storage of the results. This argument can have
the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
374 PCL Reference Manual
Tools Menu
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
29004006 Property%A% could not be retrieved from the database.
48000001 *%A% * is not a valid target list!
48000003 No Element found!
48000011 No Property selected!
Remarks:
The input value element_shape_code can have the following values:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
This function can display a fatal popup form with the following messages:
Description:
This function will retrieve from the database a list of entities with an association to groups.
Input:
INTEGER group_count This value specifies the number of groups.
STRING group_name[31](group_count) This array specifies the group names. The default
group will be used if this value is set to .
INTEGER entity_count This value specifies the number of acceptable
entity types.
STRING entity_name[7](entity_count) This array specifies the acceptable entity type
names. See the remarks below for more
information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of
entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
376 PCL Reference Manual
Tools Menu
Example:
Please see list_create_elem_ass_group (p. 298) in the PCL Reference Manual Examples.
Description:
This function will retrieve from the database a list of entities with an association to viewports.
Input:
INTEGER viewport_count This value specifies the number of viewports.
STRING viewport_name[31](viewport_ This array specifies the viewport names. The
count) default viewport will be used if this value is set to
.
INTEGER entity_count This value specifies the number of acceptable
entity types.
STRING entity_name[7](entity_count) This array specifies the acceptable entity type
names. See the remarks below for more
information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of
entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
Chapter 2: Basic Functions 377
Tools Menu
Example:
Please see list_create_ent_ass_vp (p. 309) in the PCL Reference Manual Examples.
Description:
This function will retrieve from the database a list of entities with an association to element properties.
Input:
INTEGER ep_count This value specifies the number of element
properties.
STRING ep_name[31](ep_count) This array specifies the element property names.
INTEGER entity_count This value specifies the number of acceptable
entity types.
STRING entity_name[7](entity_count) This array specifies the acceptable entity type
names. See the remarks below for more
information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message in
the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
378 PCL Reference Manual
Tools Menu
Example:
Please see list_create_ent_att_ep_name (p. 310) in the PCL Reference Manual Examples.
Description:
This function will retrieve from the database a list of entities with an association to generic element
types.
Input:
INTEGER general_count This value specifies the number of generic
element types.
STRING general_name[](general_count) This array specifies the generic element type
names. See the remarks below for more
information.
INTEGER entity_count This value specifies the number of acceptable
entity types.
STRING entity_name[7](entity_count) This array specifies the acceptable entity type
names. See the remarks below for more
information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of
entities.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate an error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Chapter 2: Basic Functions 379
Tools Menu
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
The input value general_name can have the following values:
Example:
Please see list_create_ent_att_ep_type (p. 311) in the PCL Reference Manual Examples.
Description:
This function will retrieve from the database a list of entities with an association to load and boundary
condition names.
Input:
INTEGER lbc_count This value specifies the number of load and
boundary condition names.
STRING lbc_name[31](lbc_count) This array specifies the load and boundary condition
names.
INTEGER entity_count This value specifies the number of acceptable entity
types.
STRING entity_name[7](entity_count) This array specifies the acceptable entity type
names. See the remarks below for more information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
Chapter 2: Basic Functions 381
Tools Menu
Example:
Please see list_create_ent_att_lbc_name (p. 313) in the PCL Reference Manual Examples.
Description:
This function will retrieve from the database a list of entities with an association to load and boundary
condition types.
Input:
INTEGER lbc_type_count This value specifies the number of load and
boundary condition type names.
STRING lbc_type_name[31](lbc_type_count) This array specifies the load and boundary
condition type names. See the remarks below
for more information.
INTEGER entity_count This value specifies the number of acceptable
entity types.
STRING entity_name[7](entity_count) This array specifies the acceptable entity type
names. See the remarks below for more
information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of
entities.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate an error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message in
the message database.
382 PCL Reference Manual
Tools Menu
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
The input value lbc_type_name can accept a variety of values that are dependent on the type of preference
currently loaded. Examples of these type names are Temperature, and Pressure. A complete of the
values allowed under the current preference can be seen by selecting Loads/BCs on the tool bar of
Patran and then setting the Action entry on the form to Create. The currently allowed lbc_type_name
values are displayed when the Object list on the form is selected.
The input value entity_name can have the following values:
Example:
Please see list_create_ent_att_lbc_type (p. 315) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 383
Tools Menu
Description:
This function will retrieve from the database a list of entities with an association to material property
names.
Input:
INTEGER material_count This value specifies the number of materials.
STRING material_name[31](material_count) This array specifies the material names.
INTEGER entity_count This value specifies the number of acceptable
entity types.
STRING entity_name[7](entity_count) This array specifies the acceptable entity type
names. See the remarks below for more
information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of
entities.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate an error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
The input value entity_name can have the following values:
Example:
Please see list_create_ent_att_mat_name (p. 316) in the PCL Reference Manual Examples.
384 PCL Reference Manual
Tools Menu
Description:
This function will retrieve from the database a list of entities with an association to material property
types.
Input:
INTEGER mat_type_count This value specifies the number of
material types.
STRING mat_type_name[31](mat_type_count) This array specifies the material type
names. See the remarks below for more
information.
INTEGER entity_count This value specifies the number of
acceptable entity types.
STRING entity_name[7](entity_count) This array specifies the acceptable entity
type names. See the remarks below for
more information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string
of entities.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero
value to indicate an error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
The input value mat_type_name can accept a variety of values that are dependent on the type of
preference currently loaded. Examples of these type names are Isotropic, and 2d Orthotropic. A
complete of the values allowed under the current preference can be seen by selecting Materials on the
tool bar of Patran and then setting the Action entry on the form to Create. The currently allowed
mat_type_name values are displayed when the Object list on the form is selected.
Chapter 2: Basic Functions 385
Tools Menu
Example:
Please see list_create_ent_att_mat_type (p. 318) in the PCL Reference Manual Examples.
Description:
This function will retrieve from the database a list of entities with an association to material property
word values.
Input:
INTEGER entity_count This value specifies the number of acceptable
entity types.
STRING entity_name[7](entity_count) This array specifies the acceptable entity type
names. See the remarks below for more
information.
STRING mat_prop_name[] This value specifies the material property word
name. See the remarks below for more
information.
REAL minimum This value specifies the minimum value for the
range of the material value.
REAL maximum This value specifies the maximum value for the
range of the material value.
REAL evaluation_temperature This value specifies the temperature value used for
field evaluation.
REAL evaluation_strain This value specifies the strain, total strain, plastic
strain, or stress value used for field evaluation.
REAL evaluation_rate This value specifies the strain rate value used for
field evaluation.
REAL evaluation_time This value specifies the time value used for field
evaluation.
386 PCL Reference Manual
Tools Menu
REAL evaluation_frequency This value specifies the frequency value used for
field evaluation.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of
entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
If a load and boundary condition variable value cannot be evaluated because it is based on a field which
cannot be evaluated, the corresponding material and element properties associated with the material are
skipped. A field that is of the general field type is a typical cause of this behavior.
The input value entity_name can have the following values:
9 Shear Modulus 23 . .
10 Shear Modulus 31 . .
11 Not used 502 Not used
12 Not used 503 Stress/Strain Curve
13 Poisson Ratio 13 504 Not used
14 Bulk Modulus . .
15 Lame Constant . .
16 Density . .
17 Conductivity 1000 Not used
18 Conductivity 12 1001 Mass Propornl Damping
19 Conductivity 13 1002 Stiffness Propornl Damping
20 Conductivity 22 1003 Fraction Critical Damping
21 Conductivity 23 1004 Not used
22 Conductivity 33 . .
23 Specific Heat . .
24 Thermal Expansion Coeff . .
25 Thermal Expansion Coeff 22 1010 Not used
26 Thermal Expansion Coeff 33 1011 2nd. Yield Stress
27 Thermal Expansion Coeff 12 1012 Plastic Strain
28 Thermal Expansion Coeff 23 1013 Rate Dependent Param D
29 Thermal Expansion Coeff 31 1014 Rate Dependent Param p
30 Structural Damping Coeff 1016 Dilation Angle
31 Emissivity 1017 Ratio of Flow Stresses
32 Not used 1018 Absolute Plastic Strain
. . 1019 Exponent
. . 1020 Yield Offset
. . 1021 Not used
36 Not used 1022 Not used
37 Composite Options Flag 1023 Material Cohesion
38 Positive Definite Flag 1024 Eccentricity Parameter
39 Total Laminate Thickness 1025 Yield Surface Transition
40 Number of Plies 1026 Surface Radius Parameter
41 Laminate Offset 1027 Hydrostatic Yield Stress
42 Moisture Expansion Coeff 11 1028 Volumetric Plastic Strain
388 PCL Reference Manual
Tools Menu
Example:
Please see list_create_ent_att_mat_value (p. 319) in the PCL Reference Manual Examples.
Description:
This function will retrieve from the database a list of entities with an association to viewports.
Input:
INTEGER viewport_count This value specifies the number of viewports.
STRING viewport_name[31](viewport_ This array specifies the viewport names. The
count) default viewport will be used if this value is set to
.
INTEGER entity_count This value specifies the number of acceptable
entity types.
STRING entity_name[7](entity_count) This array specifies the acceptable entity type
names. See the remarks below for more
information.
INTEGER pick_type This value specifies the type of operation used to
select entities in the viewport. This value can be set
to 0 for picking entities with a centroid visible in
the viewport, 1 for picking entities that have any
portion of themselves visible in the viewport, or 2
for picking only entities that are completely visible
in the viewport.
INTEGER pick_erased This value specifies, when set to TRUE, that
entities that have been erased but are still
associated with the viewport be considered for
retrieval.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
392 PCL Reference Manual
Tools Menu
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message in
the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
The input value entity_name can have the following values:
Example:
Please see list_create_ent_att_vp_vis (p. 322) in the PCL Reference Manual Examples.
Description:
This function queries the database for entities connected to those in a list processor string.
Input:
STRING in_list[] This value specifies the list processor string
of entities.
INTEGER get_node_con_to_node_by_elem This value specifies 1 (TRUE): get nodes
connected to nodes in the list processor
string by being part of a same Element. 0
otherwise.
INTEGER get_node_con_to_node_by_mpc This value specifies 1 (TRUE): get nodes
connected to nodes in the list processor
string by being part of a same MPC. 0
otherwise.
Chapter 2: Basic Functions 393
Tools Menu
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
Example:
Please see list_create_fem_con_fem (p. 323) in the PCL Reference Manual Examples.
Description:
This function will create a list of all nodes associated with a list of elements.
Input:
STRING element_list[] This value specifies a list of elements.
STRING target[6] This value specifies which global string will be
used for the storage of the results. This argument
can have the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of nodes.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1 This is an internal status condition. There is no corresponding status message in the
message database.
258 This is an internal status condition. There is no corresponding status message in the
message database.
259 This is an internal status condition. There is no corresponding status message in the
message database.
14000004 LpSublistType: I am being invoked with a NULL list
48000001 *%A% * is not a valid target list!
48000004 No Node found!
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
Chapter 2: Basic Functions 395
Tools Menu
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
1 Not owner
14000004 LpSublistType: I am being invoked with a NULL list
48000001 *%A% * is not a valid target list!
Description:
This function will create a list of all nodes associated with a list of geometry IDs.
Input:
STRING geometry_list[] This value specifies a list of geometry IDs.
STRING target[6] This value specifies which global string will be used
for the storage of the results. This argument can have
the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of nodes.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
396 PCL Reference Manual
Tools Menu
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000049 LpParseExpression: Excess left parenthesis detected.
14000050 LpParseExpression: Excess right parenthesis detected.
14000281 LpExpandPclVariables: Virtual memory is full.
14000308 LpEval: Memory exhausted preparing to evaluate pick.
48000004 No Node found!
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
Description:
This function will create a list of all nodes associated with a list of groups.
Input:
STRING group_list[](number_of_grou This value specifies a list of groups of geometric
ps) entities.
INTEGER number_of_groups This value specifies the number of groups in the
group_list input value.
STRING target[6] This value specifies which global string will be used
for the storage of the results. This argument can have
the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of nodes.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8104003 Out of room in destination format string.
8107002 Last command aborted.
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
398 PCL Reference Manual
Tools Menu
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
Example:
Please see list_create_node_ass_group (p. 328) in the PCL Reference Manual Examples.
Description:
This function will create a list of all nodes with a specified fringe value associated with a single group
of geometric entities.
Input:
REAL fringe_limits(2) This value specifies the lower fringe limit as the
value in offset 1 and the upper fringe limit as the
value in offset 2.
STRING fringe_comparison_type[7] This value specifies the method that will be used for
comparing the fringe limits to the fringe value of the
element shape.
REAL tolerance This value specifies a range over which a match
between the input value fringe_limits and the fringe
value for the finite element model shape can be
made.
STRING group_name[] This value specifies the name of a group of
geometric entities.
STRING target[6] This value specifies which global string will be used
for the storage of the results. This argument can have
the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of nodes.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
13000008 Group not found
13000021 Element not found
15500001 Message 15500001 not found in message file(s)
15500002 Message 15500002 not found in message file(s)
15500003 Message 15500003 not found in message file(s)
48000001 *%A% * is not a valid target list!
400 PCL Reference Manual
Tools Menu
Remarks:
The input value fringe_comparison_type can have the following values:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following message:
This function can display a warning popup form with the following messages:
Description:
This function will get all nodes with a specified coordinate value.
Input:
REAL coord_values(6) This value specifies a list of sets of fringe limits as
follows: the lower fringe limits and the upper
fringe limits for set 1 are at offsets 1 and 4, the
lower fringe limits and the upper fringe limits for
set 2 are at offsets 2 and 5, the lower fringe limits
and the upper fringe limits for set 3 are at offsets 3
and 6.
LOGICAL coord_values_active(3) This value specifies which sets of fringe values are
used for the fringe comparison by setting offset 1
TRUE for the first set, offset 2 TRUE for the
second set, and offset 3 TRUE for the third set.
STRING coord_comparison_type{} This value specifies the method that will be used
for comparing the fringe limits to the fringe value
of the element shape.
REAL tolerance(2) This value specifies a range over which a match
between the input value fringe_limits and the
fringe value for the finite element model shape can
be made.
Example:
Please see list_create_node_att_value (p. 332) in the PCL Reference Manual Examples.
Description:
Get all points associated to geometry.
Input:
STRING entity_list[] This value specifies a list of geometric entities.
STRING target[6] This value specifies which global string will be
used for the storage of the results. This argument
can have the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of points.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
Chapter 2: Basic Functions 403
Tools Menu
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000049 LpParseExpression: Excess left parenthesis detected.
14000050 LpParseExpression: Excess right parenthesis detected.
14000281 LpExpandPclVariables: Virtual memory is full.
14000308 LpEval: Memory exhausted preparing to evaluate pick.
48000001 *%A% * is not a valid target list!
48000005 No Point found!
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
Description:
This function will create a list of all points in a list of groups of geometric entities.
Input:
STRING group_list[](number_of_grou This value specifies a list of groups of geometric
ps) entities.
INTEGER number_of_groups This value specifies the number of groups in the
group_list input value.
STRING target[6] This value specifies which global string will be used
for the storage of the results. This argument can have
the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of points.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8104003 Out of room in destination format string.
8107002 Last command aborted.
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000121 There is not a current group defined.
Chapter 2: Basic Functions 405
Tools Menu
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
Description:
This function will create a list of all surfaces in a list of geometric entities.
Input:
STRING entity_list[] This value specifies a list of geometry IDs for
surfaces.
STRING target[6] This value specifies which global string will be
used for the storage of the results. This argument
can have the following values: lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of points.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
7000132 Unable to allocate enough memory for data.
14000001 LpGetHeapSpace: Allocated heap space is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000049 LpParseExpression: Excess left parenthesis detected.
Chapter 2: Basic Functions 407
Tools Menu
Remarks:
This function will modify the contents of the global string variable specified as the target input value.
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function is used in the implementation of the form that can be accessed through Tools, List,
Create on the Patran menu bar.
This function can display a warning popup form with the following messages:
Description:
This function will create a list of all surfaces in a list of groups of geometric entities.
Input:
STRING group_list[](number_of_groups) This value specifies a list of groups of
geometric entities.
INTEGER number_of_groups This value specifies the number of groups in
the group_list input value.
STRING target[6] This value specifies which global string will
be used for the storage of the results. This
argument can have the following values:
lista, or listb.
Output:
STRING return_list[VIRTUAL] This value returns a list of surfaces.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8104003 Out of room in destination format string.
8107002 Last command aborted.
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000121 There is not a current group defined.
11000127 The group does not have any entities in it.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000008 Group not found
Chapter 2: Basic Functions 409
Tools Menu
Remarks:
This function is used in the implementation of the form that can be accessed through Tools, List,
Create on the Patran menu bar.
Space is internally allocated for the output value return_list. It is the responsibility of the calling function
to free the allocated string storage space.
This function can display an information popup form with the following messages:
This function can display a warning popup form with the following messages:
Description:
This function allocates space for a string, sets the value of the allocated string using an input value, and
assigns the allocated string to one of two global string variables named lista or listb based on the
settings of two matching internal global variables named lista_nomerge and listb_nomerge.
Input:
STRING target[] This value specifies which global string will be used
for the storage of the results. This argument can have
the following values: lista, or listb.
STRING entity_list[] This value specifies a list of entities to be stored.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
48000001 *%A% * is not a valid target list!
Remarks:
The input value target can have the following values: lista, or listb.
The behavior of this function is influenced by the settings in the following global variables:
LOGICAL lista_nomerge
LOGICAL listb_nomerge
This function can modify the following global variables:
STRING list_a[VIRTUAL]
STRING list_b[VIRTUAL]
STRING lista_reset[VIRTUAL]
STRING listb_reset[VIRTUAL]
If the input value target is set to lista or listb and the matching lista_nomerge or listb_nomerge global
value is set to TRUE, the string passed in the input return_list will be placed at the start of the string stored
in the lista or listb value specified by target. If the matching lista_nomerge or listb_nomerge global values
are set to FALSE, the PCL function list_create_boolean_list() is used to create a sorted list that is placed
at the start of the string stored in the lista or listb value specified by target.
This function saves the old value for lista in the global string lista_reset and the old value for listb in
listb_reset.
By default the lista_nomerge and listb_nomerge global variables are set to FALSE.
Chapter 2: Basic Functions 411
Tools Menu
This function will display a warning popup form with the following message if the target input value is
out of range:
Example:
Please see list_create_target_list (p. 339) in the PCL Reference Manual Examples.
Description:
This function will create a list processor string of entities for elements which have dimensions within
a specified range.
Input:
STRING input_list[] This value specifies the list processor string of
entities that will be filtered by this function.
STRING criterion[13] This value specifies the element attribute criterion
for evaluation. See the remarks below for more
information.
INTEGER segment_count This value specifies the number of segments
desired for length evaluation on an element edge.
Isoparametric shape functions are used for the
evaluation of intermediate locations. If this value
is 0, then consider segments formed by the straight
lines between the nodes along the edge.
REAL minimum This value specifies the minimum value for the
range of the specified criterion.
REAL maximuim This value specifies the maximum value for the
range of the specified criterion.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of entities
that fit the range and attribute criteria specified in
the input values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
412 PCL Reference Manual
Tools Menu
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
The input value criterion uses the following values to specify the element attributes for evaluation:
Value Description
Example:
Please see list_filter_by_elem_dim (p. 341) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 413
Tools Menu
Description:
This function will create a list processor string of entities match the specified entity types.
Input:
STRING input_list[] This value specifies the list processor string of
entities that will be filtered by this function. See the
remarks below for more information.
INTEGER geometric_points This value specifies, when set to FALSE, that all
zero dimensional geometric or point entities be
ignored.
INTEGER geometric_curves This value specifies, when set to FALSE, that all
single dimensional geometric or curve entities be
ignored.
INTEGER geometric_surfaces This value specifies, when set to FALSE, that all two
dimensional geometric or surface entities be
ignored.
INTEGER geometric_solids This value specifies, when set to FALSE, that all
three dimensional geometric or solid entities be
ignored.
INTEGER element_points This value specifies, when set to FALSE, that all
zero dimensional or point elements be ignored.
INTEGER element_beams This value specifies, when set to FALSE, that all
single dimensional or beam elements be ignored.
INTEGER element_tria This value specifies, when set to FALSE, that all two
dimensional triangular elements be ignored.
INTEGER element_quad This value specifies, when set to FALSE, that all two
dimensional quadrilateral elements be ignored.
INTEGER element_tet This value specifies, when set to FALSE, that all
three dimensional tetrahedral elements be ignored.
INTEGER element_wedge This value specifies, when set to FALSE, that all
three dimensional wedge elements be ignored.
INTEGER element_hex This value specifies, when set to FALSE, that all
three dimensional hexagonal elements be ignored.
414 PCL Reference Manual
Tools Menu
INTEGER node This value specifies, when set to FALSE, that all
nodes be ignored.
INTEGER mpc This value specifies, when set to FALSE, that all
mass property constraints be ignored.
INTEGER any_other This value specifies, when set to FALSE, that all
entities of a type that is not listed above be ignored.
Output:
STRING return_list[ VIRTUAL] This value returns a list processor string of entities
that match the specified types.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
An example of a list processor string used as an input for this function might look like this:
Surface 1.3 Element 1 2.4
Note that only the last level of the sub-entities are considered by this function: in Surface 1.3 we are
considering the hypothetical curve defined by the 3rd edge of surface 1. In Element 2.4 we consider
the hypothetical element defined by face 1 of element 3.
Example:
Please see list_filter_by_ent_shape (p. 342) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 415
Tools Menu
Description:
This function will create a list processor string of entities that match the specified element property
types.
Input:
STRING input_list[] This value specifies the list processor
string of entities that will be filtered by
this function.
INTEGER ep_type_count This value specifies the number of
generic element types.
STRING ep_type_name[31](type_count) This array specifies the generic element
type names. See the remarks below for
more information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string
of entities that match the specified types.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero
value to indicate an error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
416 PCL Reference Manual
Tools Menu
Example:
Please see list_filter_by_ep_type (p. 344) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 417
Tools Menu
Description:
This function will create a list processor string of entities that match the specified element property
word value range.
Input:
STRING input_list[] This value specifies the list processor string of
entities that will be filtered by this function.
STRING element_property[] This value specifies the element property word
string. See the remarks below for more
information.
INTEGER component This value specifies the component of data to
extract. This value ranges from 1 to 3 and is
ignored if the entities in the input value
input_list are scalar values.
REAL minimum This value specifies the minimum value for the
range of the specified criterion.
REAL maximum This value specifies the maximum value for the
range of the specified criterion.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of
entities that match the specified types.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
The input value element_property can have the following word name values:
418 PCL Reference Manual
Tools Menu
Example:
Please see list_filter_by_ep_value (p. 346) in the PCL Reference Manual Examples.
Description:
This function will create a list processor string of entities that match the specified FEM type.
Input:
STRING input_list[] This value specifies the list processor string of entities
that will be filtered by this function.
INTEGER fem_type_count This value specifies the number of finite element type
names.
STRING fem_type_name[31](fem This array specifies the finite element types. See the
_type_count) remarks below for more information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message in
the message database.
Chapter 2: Basic Functions 425
Tools Menu
Remarks:
The input value fem_type_name can accept the following FEM type values:
Specific MPC types can be selected for other preferences by using the same names as those listed in the
preference form and adding MPC/ as a prefix to the name while being careful to include and spaces in
the original name.
Memory is allocated for the return list output variable within this function. If memory was allocated prior
to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no
need to release the memory of the output variable.
Example:
Please see list_filter_by_fem_type (p. 348) in the PCL Reference Manual Examples.
426 PCL Reference Manual
Tools Menu
Description:
This function will create a list processor string of entities that match the specified load and boundary
condition type.
Input:
STRING input_list[] This value specifies the list processor string of
entities that will be filtered by this function.
INTEGER lbc_type_count This value specifies the number of load and
boundary condition type names.
STRING lbc_type_name[31](lbc_type_cou This array specifies the load and boundary
nt) condition type names. See the remarks below
for more information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of
entities.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate an error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
The input value lbc_type_name can accept a variety of values that are dependent on the type of preference
currently loaded. Examples of these type names are Temperature, and Pressure. A complete of the
values allowed under the current preference can be seen by selecting Loads/BCs on the tool bar of
Patran and then setting the Action entry on the form to Create. The currently allowed lbc_type_name
values are displayed when the Object list on the form is selected.
Example:
Please see list_filter_by_lbc_type (p. 350) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 427
Tools Menu
Description:
This function will create a list processor string of entities that match the specified load and boundary
condition value range.
Input:
STRING input_list[] This value specifies the list processor string of entities
that will be filtered by this function. Face and edge sub-
entity ids are ignored.
STRING load_case_name[] This value specifies the load case name. The default load
case is used if this value is set to .
STRING lbc_var_name[] This value specifies the load and boundary condition
variable name. See the remarks below for more
information.
INTEGER component This value specifies the component of data to extract.
This value ranges from 1 to 3 and is ignored if the entities
in the input value input_list are scalar values.
REAL minimum This value specifies the minimum value for the range of
the load and boundary condition value.
REAL maximum This value specifies the maximum value for the range of
the load and boundary condition value.
REAL evaluation_time This value specifies the time value used for field
evaluation.
REAL evaluation_frequency This value specifies the frequency value used for field
evaluation.
STRING sub_entity[] This value specifies, when set to ANY, that any sub-
entity that corresponds to the input value lbc_var_name
that has a value in the specified range be listed in the
output value return_list. When this value is set to ALL,
all sub-entities with values in the specified range are
included in the output value return_list.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an error.
428 PCL Reference Manual
Tools Menu
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message in
the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
If a load and boundary condition variable value cannot be evaluated because it is based on a field which
cannot be evaluated, the corresponding load and boundary condition is skipped and the entities associated
with the load and boundary condition are skipped. A field that is of the general field type is a typical cause
of this behavior.
Examples of load and boundary condition variable names would look like the following strings. If the
variable name is not found, the function will exit normally.
Bot Surf Pressure
Translations <T1 T2 T3>
Temperature
Example:
Please see list_filter_by_lbc_value (p. 352) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 429
Tools Menu
Description:
This function will create a list processor string of entities that are associated to a material name.
Input:
STRING input_list[] This value specifies the list processor string of
entities that will be filtered by this function.
INTEGER mat_count This value specifies the number of material names.
STRING mat_name[31](mat_count) This array specifies the material names.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message in
the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
Example:
Please see list_filter_by_mat_name (p. 354) in the PCL Reference Manual Examples.
430 PCL Reference Manual
Tools Menu
Description:
This function will create a list processor string of entities that are associated to a material type.
Input:
STRING input_list[] This value specifies the list processor string of
entities that will be filtered by this function.
INTEGER mat_type_count This value specifies the number of material
types.
STRING mat_type_name[31](mat_type_co This array specifies the material type names.
unt) See the remarks below for more information.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of
entities.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate an error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
The input value mat_type_name can accept a variety of values that are dependent on the type of
preference currently loaded. Examples of these type names are Isotropic, and 2d Orthotropic. A
complete of the values allowed under the current preference can be seen by selecting Materials on the
tool bar of Patran and then setting the Action entry on the form to Create. The currently allowed
mat_type_name values are displayed when the Object list on the form is selected.
Example:
Please see list_filter_by_mat_type (p. 355) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 431
Tools Menu
Description:
This function will create a list processor string of entities that match the specified material property
value range.
Input:
STRING input_list[] This value specifies the list processor string of
entities that will be filtered by this function.
STRING mat_prop_name[] This value specifies the material property word
name. See the remarks below for more
information.
REAL minimum This value specifies the minimum value for the
range of the material value.
REAL maximum This value specifies the maximum value for the
range of the material value.
REAL evaluation_temperature This value specifies the temperature value used
for field evaluation.
REAL evaluation_strain This value specifies the strain, total strain,
plastic strain, or stress value used for field
evaluation.
REAL evaluation_rate This value specifies the strain rate value used for
field evaluation.
REAL evaluation_time This value specifies the time value used for field
evaluation.
REAL evaluation_frequency This value specifies the frequency value used for
field evaluation.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of
entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
432 PCL Reference Manual
Tools Menu
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
If a material property value cannot be evaluated because it is based on a field which cannot be evaluated,
the corresponding material property is skipped and the entities associated with the material property are
skipped. A field that is of the general field type is a typical cause of this behavior.
The input value mat_prop_name can have the following values:
23 Specific Heat . .
24 Thermal Expansion Coeff . .
25 Thermal Expansion Coeff 22 1010 Not used
26 Thermal Expansion Coeff 33 1011 2nd. Yield Stress
27 Thermal Expansion Coeff 12 1012 Plastic Strain
28 Thermal Expansion Coeff 23 1013 Rate Dependent Param D
29 Thermal Expansion Coeff 31 1014 Rate Dependent Param p
30 Structural Damping Coeff 1016 Dilation Angle
31 Emissivity 1017 Ratio of Flow Stresses
32 Not used 1018 Absolute Plastic Strain
. . 1019 Exponent
. . 1020 Yield Offset
. . 1021 Not used
36 Not used 1022 Not used
37 Composite Options Flag 1023 Material Cohesion
38 Positive Definite Flag 1024 Eccentricity Parameter
39 Total Laminate Thickness 1025 Yield Surface Transition
40 Number of Plies 1026 Surface Radius Parameter
41 Laminate Offset 1027 Hydrostatic Yield Stress
42 Moisture Expansion Coeff 11 1028 Volumetric Plastic Strain
43 Moisture Expansion Coeff 22 1029 Not used
44 Moisture Expansion Coeff 33 . .
45 Moisture Expansion Coeff 12 . .
46 Moisture Expansion Coeff 23 . .
47 Moisture Expansion Coeff 31 1100 Not used
48 Force Resultant (N1) per Temp 1101 Real Part of g1
49 Force Resultant (N2) per Temp 1102 Imaginary Part of g1
50 Force Resultant (N12) per Temp 1103 Value of a
51 Moment Resultant (M1) per Temp 1104 Real Part of k1
52 Moment Resultant (M2) per Temp 1105 Imaginary Part of k1
53 Moment Resultant (M12) per Temp 1106 Value of b
54 Stiffness 11 1107 Not used
55 Stiffness 12 . .
56 Stiffness 13 . .
434 PCL Reference Manual
Tools Menu
57 Stiffness 22 . .
58 Stiffness 23 1200 Not used
59 Stiffness 33 1201 Value of A
60 Stiffness 44 1202 Value of B
61 Stiffness 45 1203 Value of n
62 Stiffness 46 1204 Value of m
63 Stiffness 55 1205 Value of delta_H
64 Stiffness 56 1206 Value of R
65 Stiffness 66 1207 Not used
66 Stiffness 14 . .
67 Stiffness 15 . .
. Stiffness 16 .
68 Not used 1300 Not used
69 Stiffness 24 1301 Coefficient C10
70 Stiffness 25 1302 Coefficient C20
71 Stiffness 26 1303 Coefficient C30
72 Stiffness 34 1304 Coefficient C40
73 Stiffness 35 1305 Coefficient C50
74 Stiffness 36 1306 Coefficient C60
75 Stiffness 11 1307 Not used
76 Stiffness 12 1308 Not used
77 Stiffness 13 1309 Not used
78 Stiffness 22 1310 Not used
79 Stiffness 23 1311 Coefficient C01
80 Stiffness 33 1312 Coefficient C02
81 Membrane Stiffness 11 1313 Coefficient C03
82 Membrane Stiffness 12 1314 Coefficient C04
83 Membrane Stiffness 13 1315 Coefficient C05
84 Membrane Stiffness 22 1316 Coefficient C06
85 Membrane Stiffness 23 1317 Not used
86 Membrane Stiffness 33 1318 Not used
87 Bending Stiffness 11 1319 Not used
88 Bending Stiffness 12 1320 Not used
89 Bending Stiffness 13 1321 Coefficient C11
Chapter 2: Basic Functions 435
Tools Menu
Example:
Please see list_filter_by_mat_value (p. 357) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 437
Tools Menu
Description:
This function will create a list processor string of entities by using a specified acceptance criteria to
compare to list processor strings.
Input:
STRING input_list[] This value specifies the list processor string of
entities that will be filtered by this function.
STRING acceptance_criteria[7] This value specifies the acceptance criterion for a
match. See the remarks below for more
information.
STRING reference_list[] This value specifies the list processor string of
entities that will be used as the reference input for
the comparison operation.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
The input value acceptance_criteria can be set to the following values:
Value Description
exact Specifies that an accepted entity must match exactly in the two input lists.
parent Specifies that an accepted entity in the input value input_list must be a parent of an entity
in the input value reference_list.
id Specifies that an accepted entity must have an id value that matches exactly in the two
input lists.
438 PCL Reference Manual
Tools Menu
s_id Specifies that an accepted entity in the input value input_list must match an entity in the
input value reference_list at the sub-id level.
ss_id Specifies that an accepted entity in the input value input_list must match an entity in the
input value reference_list at the sub-sub-id level.
sss_id Specifies that an accepted entity in the input value input_list must match an entity in the
input value reference_list at the sub-sub-sub-id level.
Example:
Please see list_filter_by_presence (p. 359) in the PCL Reference Manual Examples.
Description:
This function will get the intersection of entities by performing comparisons at the entity and up to
third sub-entity level.
Input:
STRING input_list_1[] This value specifies the first list processor string of
entities.
STRING input_list_2[] This value specifies the second list processor string
of entities.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string describing
the intersecting entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
Example:
Please see list_intersect (p. 360) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 439
Tools Menu
Description:
This function will create a list processor string from which any duplicate entities have been removed.
Input:
STRING input_list[] This value specifies the list processor string of entities
that will searched for duplicates.
Output:
STRING return_list[VIRTUAL] This value returns a list processor string of entities with
an duplicate entities removed.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
This function will remove duplicate entities down to the third sub-entity level and will regroup entity
keywords.
Example:
Please see list_rem_duplicate (p. 361) in the PCL Reference Manual Examples.
440 PCL Reference Manual
Tools Menu
Description:
This function will add a list of entities stored in a global string variable into a group.
Input:
STRING target[] This value specifies which global string will be used for the
storage of the results. This argument can have the following
values: lista, listb, or listc.
STRING group_name[] This value specifies the name of the group to which the
entities are stored.
LOGICAL update This value specifies, if set to TRUE, that the viewport that
contains the newly updated group will be updated.
Output:
None.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1000025 Error attempting to allocate virtual memory.
11000011 The entity is not contained in the specified group.
11000012 The entity is already contained in the specified group.
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000121 There is not a current group defined.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000008 Group not found
13000014 Viewport not found
48000001 *%A% * is not a valid target list!
Remarks:
If the group specified by the input value group_name does not exist, it will be created.
This function will display a warning popup form with the following message if the target input value is
out of range:
This function uses a warning popup form to report any errors returned by call to the function
ga_group_entity_add().
This function uses an acknowledgment popup form to report any error returned by a call to the function
ga_group_exist_get().
Example:
Please see list_save_group (p. 362) in the PCL Reference Manual Examples.
uil_list_a.previous ()
Description:
This function will swap the contents of the global string variable lista with the contents of the global
string variable lista_reset.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_a.previous (p. 363) in the PCL Reference Manual Examples.
442 PCL Reference Manual
Tools Menu
uil_list_b.previous ()
Description:
This function will swap the contents of the global string variable listb with the contents of the global
string variable listb_reset.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_b.previous (p. 365) in the PCL Reference Manual Examples.
uil_list_a.clear ()
Description:
This function sets the global string lista_reset to the contents of the global string lista and then sets
lista to a single space.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_a.clear (p. 366) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 443
Tools Menu
uil_list_b.clear ()
Description:
This function sets the global string listb_reset to the contents of the global string listb and then sets listb
to a single space.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_b.clear (p. 367) in the PCL Reference Manual Examples.
uil_list_boolean.create (boolean)
Description:
This function creates a list of entities by combining the contents of the global strings lista and listb
using the type of operation specified by the input value boolean and placing the results in the global
string listc.
Input:
STRING boolean[7] This value specifies the type of combination
operation. See the remarks below for more
information.
Output:
None.
Error Conditions:
None.
Remarks:
444 PCL Reference Manual
Tools Menu
The input value boolean can have the following values used to specify the different types of
combinational operations which combine the lists listed by the global string values lista and listb in the
following manner:
This function can display an information popup form with the following message:
This function can display an information popup form with the following message:
uil_list_a.replace ()
Description:
This function will set the contents of the global string variable lista_reset to equal the contents of the
global string variable lista. It will then set the global string variable lista to equal the contents of the
global string variable listc.
Input:
None.
Output:
None.
Error Conditions:
None.
Chapter 2: Basic Functions 445
Tools Menu
Remarks:
None.
Example:
Please see uil_list_a.replace (p. 369) in the PCL Reference Manual Examples.
uil_list_b.replace ()
Description:
This function will set the contents of the global string variable listb_reset to equal the contents of the
global string variable listb. It will then set the global string variable listb to equal the contents of the
global string variable listc.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_b.replace (p. 370) in the PCL Reference Manual Examples.
Description:
This function creates a region.
INPUT
STRING name The name of the region
STRING targ_entity Target entity type (Node,
Element, Edge, Face)
INTEGER targ_type Target element type:
0 = 0D Element or Node
1 = 1D Element
446 PCL Reference Manual
Tools Menu
2 = 2D Element or Edge
3 = 3D Element or Face
STRING app_region[VIRTUAL] The application region for the
Region definition
OUTPUT
<return value> 0 for success, non-zero on
error
region.delete ( names )
Description:
This function deletes the region.
INPUT
STRING names[32]() Array of names of regions for deletion
OUTPUT
<return value> 0 for success, non-zero on
error
Description:
This function modifies the region.
INPUT
STRING old_name The original name of the region
STRING new_name The new name of the region
STRING targ_entity Target entity type (Node, Element, Edge, Face)
INTEGER targ_type Target element type:
0 = 0D Element or Node
1 = 1D Element
2 = 2D Element or Edge
3 = 3D Element or Face
STRING app_region[VIRTUAL] The application region for the Region definition
Chapter 2: Basic Functions 447
Tools Menu
OUTPUT
<return value> 0 for success, non-zero on
error
Description:
This function gets the region data, i.e. target entity, target type and the application region..
INPUT
STRING name The name of the required region
OUTPUT
STRING targ_entity Target entity type (Node, Element, Edge, Face)
INTEGER targ_type Target element type:
0 = Node or 0D Element
1 = 1D Element
2 = 2D Element or Edge
3 = 3D Element or Face
STRING app_region[VIRTUAL] The application region for the Region definition
region.does_region_exist ( name )
Description:
This function checks if the given region exists.
INPUT
STRING name The name of the region
OUTPUT
<return value> 1 = region exists, 0 = region does not
exist
Description:
This function gets the number of regions in the database and the array of rigion names.
INPUT
448 PCL Reference Manual
Tools Menu
None
OUTPUT
INTEGER nregions Number of regions in the database
STRING names[32](VIRT Array of the region names
UAL)
Chapter 2: Basic Functions 449
Tools Menu
Description:
This function will calculate the mass properties of a set of finite element and geometric entities, can
plot the principal axes of the inertia tensor at the center of gravity, and can create and post a coordinate
frame that is aligned with the principal axes of the inertia tensor.
Input:
STRING analysis_model_type[15] This value specifies the analysis model type.
This argument may have the value 3D, 2D
Axisymmetric, 2D Plane Stress, or 2D
Plane Strain.
STRING all_or_group[5] This value specifies the use of all entities in a
model or to make use of a list of groups of
entities for the mass property calculations. This
value may be set to All or Group.
STRING include[8] This value specifies the selection of geometric
or finite element entities or both types of
entities. This value may be set to Geometry,
FEM, or Both
INTEGER number_of_groups This value specifies the number of groups in the
region to which this mass property applies. This
value is ignored if the input value all_or_group
is set to All.
STRING groups[31](number_of_groups) This value specifies an array of group names
that will be used for mass property calculations.
The number of offsets defined for this array
should be equal to the value of the input value
number_of_groups. This argument is ignored if
the input value all_or_group is set to All.
450 PCL Reference Manual
Tools Menu
INTEGER other_axis This value specifies an axis that along with the
input value axisymmetric_axis defines the
axisymmetric modeling plane. This argument
may have a value of 1, 2, or 3 and is used only
when the input value analysis_model_type is set
to 2D Axisymmetric.
LOGICAL plot This value specifies, when set to TRUE, that the
principal axes of the inertia tensor to be plotted.
LOGICAL aligned_frame This value specifies, when set to TRUE, that a
coordinate frame that is aligned with the
principal axes of inertia be created.
Output:
REAL mass_properties(VIRTUAL) This value returns a 68 element array of mass
properties. See the remarks below for more
information.
STRING entity_list[VIRTUAL] This value returns a list of all entities passed to
this function as a string in the list processor
format.
INTEGER length_entities This value returns the length of the string in the
return value entity_list.
INTEGER number_of_entities This value returns the number of entities in the
list of entities returned by the output value
entity_list.
STRING reject_list[VIRTUAL] This value returns list of entities that were not
included in the mass property calculations.
INTEGER length_reject This value returns the length of the string in the
output value reject_list.
INTEGER number_of_rejects This value returns the number of entities in the
list of entities returned by the output value
reject_list.
INTEGER segment_id This value returns the segment ID for the plot of
the principal axes of the inertia tensor. This
argument will be set to -1 if the input value plot
is set to FALSE.
INTEGER aligned_label This value returns the label for a coordinate
frame that has been created so that it is
coincident with the principle axes of inertia. If
the input value aligned_frame is set to FALSE,
this output value will be set to 0.
452 PCL Reference Manual
Tools Menu
INTEGER coordinate_label This value returns the label for the coordinate
frame defined by the input value
coordinate_frame.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-1 This is an internal status condition. There is no corresponding status message in the
message database.
1 This is an internal status condition. There is no corresponding status message in the
message database.
2001083 A system error has occurred in the FEM C Applications Memory Manager.
2001084 Unable to acquire %I% bytes of virtual memory.
2001085 A programming error has resulted in an attempt to free unallocated memory.
2001086 A programming error has resulted in an attempt to reallocate unallocated memory.
2001087 A programming error has resulted in an attempt to acquire zero bytes of virtual
memory.
8107002 Last command aborted.
13000002 Unrecoverable database error
13000004 Duplicate entry exists in table
13000006 Referenced item is missing
13000007 An unspecified database error occurred
13000008 Group not found
13000020 Node not found
13000021 Element not found
13000032 Point not found
13000041 Element not found
13000056 Coordinate frame not found
13000088 Preference not found
13000097 Curve input was not found
13000098 Solid input was not found
13000107 Vector input was not found
13000122 The surface requested was not found
13000126 The entity specified in the query was not labeled.
13000210 The system is out of virtual memory.
Chapter 2: Basic Functions 453
Tools Menu
Remarks:
The output values mass_properties, entity_list, and reject_list are all VIRTUAL data arrays that have
memory space allocated by the called function. It is the responsibility of the calling function to free
memory returned by these arguments in an appropriate manner.
456 PCL Reference Manual
Tools Menu
The output value mass_properties returns an array whose offsets contain the following information.:
1 This offset returns the volume of the entities used in the mass properties
calculations.
2 This offset returns the mass of the entities used in the mass properties calculations.
3-5 These offsets are used to return the center of gravity coordinates for the entities
used in the mass properties calculations in the specified coordinate frame. The
specified coordinate frame is listed in the output value coordinate_label.
6-11 These offsets are used to return the inertia tensor in the specified coordinate
frame. The specified coordinate frame is listed in the output value
coordinate_label.
12-17 These offsets are used to return the inertia tensor at the center of gravity point in
the specified coordinate frame. The specified coordinate frame is listed in the
output value coordinate_label.
18-20 These offsets are used to return the principle axes of the moments of inertia at the
center of gravity point in the specified coordinate frame. The specified coordinate
frame is listed in the output value coordinate_label.
21-29 These offsets are used to return the direction for the principle axes of the moments
of inertia in the specified coordinate frame. The specified coordinate frame is
listed in the output value coordinate_label.
30-32 These offsets are used to return radii of gyration corresponding to the principal
inertial axes.
33-35 These offsets are used to return the center of gravity in the reference Cartesian
coordinate frame. The reference Cartesian coordinate frame is listed in the output
value aligned_label.
36-41 These offsets are used to return the inertia tensor in the reference Cartesian
coordinate frame. The reference Cartesian coordinate frame is listed in the output
value aligned_label.
42-47 These offsets are used to return the inertia tensor at the center of gravity in the
reference Cartesian coordinate frame. The reference Cartesian coordinate frame
is listed in the output value aligned_label.
48-56 These offsets are used to return the direction for the principle axes of the moments
of inertia in the reference Cartesian coordinate. The reference Cartesian
coordinate frame is listed in the output value aligned_label.
57-59 These offsets are used to return the principal directions for the axes of the
moments of inertia in the axes order 3-2-1 of the space fixed rotation angles from
the specified coordinate system. The specified coordinate frame is listed in the
output value coordinate_label.
Chapter 2: Basic Functions 457
Tools Menu
60-62 These offsets are used to return the principal directions for the axes of the
moments of inertia in the axes order 3-1-3 of the body fixed rotation angles from
the specified coordinate system. The specified coordinate frame is listed in the
output value coordinate_label.
63-65 These offsets are used to return the principal directions for the axes of the
moments of inertia in the axes order 3-2-1 of the space fixed rotation angles from
the reference Cartesian coordinate frame. The reference Cartesian coordinate
frame is listed in the output value aligned_label.
66-68 These offsets are used to return the principal directions of the inertia tensors in the
axes order 3-1-3 of the body fixed rotation angles from the reference Cartesian
coordinate frame. These symmetric inertia tensors are in the axes order XX, XY,
XZ, YY, YZ, ZZ. The reference Cartesian coordinate frame is listed in the output
value aligned_label.
2001083 A system error has occurred in the FEM C Applications Memory Manager.
2001084 Unable to acquire %I% bytes of virtual memory.
2001085 A programming error has resulted in an attempt to free unallocated memory.
2001086 A programming error has resulted in an attempt to reallocate unallocated
memory.
2001087 A programming error has resulted in an attempt to acquire zero bytes of virtual
memory.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is
unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
uncalssifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the
sublist filter.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049 LpParseExpression: Excess left parenthesis detected.
458 PCL Reference Manual
Tools Menu
53000012 A database error occurred while attempting to fetch the physical property IDs
for element property region %I% having entities of dimension %I%.
53000013 A database consistency error occurred while attempting to fetch physical
property %I% of element property region %I%.
53000014 Unable to perform a database fetch of a coordinate frame (Internal ID = %I%).
53000015 Unable to fetch the definition data for element property region %I%.
53000016 Unable to fetch the properties of material %I%.
53000017 Unable to fetch the definition for %A% %I%.
53000018 Unable to perform a database fetch of a coordinate frame (Internal ID = %I%)
referenced by a concentrated mass.
53000019 Unable to fetch the coordinates of a point to determine the location of a
concentrated mass.
53000020 Unable to fetch the coordinates of a 0D element.
53000021 Unable to initialize field %I% for evaluation.
53000022 A programming error has occurred while attempting to process a solid entity in
an axisymmetric model. An earlier filter should have prevented this. For a
workaround, please do not specify any such entities for mass properties
calculation.
53000026 No mass properties can be calculated for any of the entities in the specified
region. The reasons are given in the ensuing warning messages. Check the
History window for multiple warning messages.
53000027 None of the entities in the specified region is compatible with the requested
analysis type.
53000028 The list of included entities could not be generated.
53000043 Unable to calculate a normal for 2D element %I%.
53000044 Unable to process the geometric definition for %A% %I%.
53000046 The modeling plane cannot be uniquely determined from the entities specified.
53000048 A normal to the axisymmetric modeling plane cannot be determined.
53000050 Unable to evaluate a point relative to the 2D modeling plane.
53000051 Unable to evaluate a point of %A%.
53000065 Unable to evaluate the area of %A%.
53000067 The specified axis of symmetry divides the specified model. Mass properties
can only be calculated when all of the specified entities are on the same side of
the symmetry axis.
53000068 A database error occurred while attempting to fetch the element property
regions for the specified entities.
460 PCL Reference Manual
Tools Menu
53000070 Zero-dimensional entities are not included in the mass property calculations if
you do not specify that Element Properties are to be used to determine density
and concentrated mass. Consequently there are no valid entities in the specified
region.
53000029 The list of rejected entities could not be generated.
30001424 Routine to locate points in elements did not converge for %I% interpolants.
30001434 0D and/or 1D Elements have been detected in the group which was used to
define this FEM Field. These elements will be ignored during any evaluation of
this field as FEM Field evaluators have not yet been implemented for these
elements.
53000030 Some of the specified entities were excluded from the mass property
calculations because no element property region has been specified for them.
53000031 Some of the specified entities were excluded from the mass property
calculations because they are not consistent with the specified analysis model
type.
53000032 Some of the specified entities were excluded from the mass property
calculations because they have no material assigned to them in their element
property records.
53000033 Some of the specified entities were excluded from the mass property
calculations because some of their needed element properties are not found or
represented using data types that are supported by the Mass Properties.
53000034 Some of the specified concentrated mass elements have inertia tensors specified
in non-rectangular frames. These inertia tensors are assumed to be defined on a
rectangular frame whose axes are coincident with the axes of the specified non-
rectangular frame.
53000035 Some of the specified tapered beams were excluded from the mass property
calculations because their element property records have non-constant cross-
sectional areas.
53000036 Some of the specified entities were excluded from the mass property
calculations because their element property definitions lack a needed physical
property such as shell thickness or beam cross-sectional area.
53000037 Some of the specified entities were excluded from the mass property
calculations because their material property definitions lack a needed property
such as density.
53000038 Some of the specified point entities were excluded from the mass property
calculations because they have no mass.
Chapter 2: Basic Functions 461
Tools Menu
53000039 Some of the specified entities were excluded from the net mass property
calculations because errors occurred in the numerical integration of their mass
properties. This is often caused by a shortage of available virtual memory or a
property defined by a field that cannot be integrated over the entity.
53000040 The coordinate frame aligned with the principal axes of inertia could not be
generated. This is usually an indication of a corrupted database or a lack of
available virtual memory.
53000042 The principal axes of inertia cannot be plotted.
53000047 Some of the specified entities were excluded from the mass property
calculations because they are not planar.
53000049 Some of the specified entities were excluded from the mass property
calculations because they are not in the modeling plane.
53000059 Some of the specified entities were excluded from the net mass property
summation because their calculated mass is zero. This problem can occur when
a property is defined by a field that cannot be integrated over the entity.
53000060 Some of the specified entities were excluded from the net mass property
summation because their calculated volume is zero. The excluded entities are
not point entities, so their calculated mass must also be zero. This problem can
occur when the wrong modeling plane is specified for an axisymmetric model
or when part of an entity crosses the axis of symmetry.
53000062 Some of the concentrated masses have the moments of inertia defined. This can
cause counter-intuitive results to occur when the 2D Axisymmetric analysis
type is selected. The input moments of inertia are treated as moment of inertia
densities and are multiplied by 2*PI*radius to determine their contribution to
the net inertia tensor of the concentrated mass.
53000063 Some of the referenced element properties define an offset. All offsets are
ignored in the calculation of mass properties. This can cause the results to
change substantially.
53000064 Not all of the principal axes of inertia can be plotted. Their lengths are
determined by the three radii of gyration corresponding to the three principal
inertias, and some of these are zero.
53000066 Some of the materials referenced by the specified entities have density defined
by a field. Density fields are not supported for mass property calculations.
Entities referencing a density field will be assigned a density of zero.
Unable to display newly created principal coordinate frame %I%.
53000069
The specified zero-dimensional entities were excluded from the mass property
53000071
This function can display the following percent done popup forms:
Example:
Please see mass_prop_create (p. 372) in the PCL Reference Manual Examples.
Chapter 2: Basic Functions 463
Tools Menu
Description:
For a given set of FEM and/or Geometric entities, calculate the mass properties based on selecting
Geometry, FEM, or Both and returning them as a summary, or on a per group or entity basis. If
requested, plot the principal axes of the inertia tensor at the CG, and create and post a coordinate frame
aligned with those axes. This function is typically used in conjunction with
mass_prop.cleanup_detailed and mass_prop.gen_report_detailed.
Input:
STRING an_mod_typ[] Analysis model type. It may be either 3D, 2D
Axisymmetric, 2D Plane Stress, or 2D Plane
Strain.
STRING select_type[] This first region specifier, may be either All ,
Group or "Selected".
STRING include[] This second region specifier, may be either
Geometry, FEM, or Both.
STRING display[] This determines how the results are displayed to
the spreadsheet. Either "Summary", "Group", or
"Entity". For display of Summary, duplicate
entries will be filtered out to avoid counting
entities more than once.
INTEGER ngroups Number of groups in the region for mass
properties. If "select_type" is set to "Group" then
this is the number of groups. If "select_type" is set
to "Entity" or "All", then this value is ignored.
STRING groups[32](VIRTUAL) If "display" is set to "Group" or "All", then this is
an array of group names in the region for mass
properties. If "display" is set to "Entity", this value
is ignored.
STRING entities[VIRTUAL] The list of entities specified if the select_type is set
to "Selected". This value is ignored if the
select_type is set to "All" or "Group".
464 PCL Reference Manual
Tools Menu
INTEGER entity_types This will tell what type of entity is given in the
(noutputs) entity_ids array above. Duplicate IDs may exist
for an element & a surface for example. This array
would give the corresponding lpenums.i value to
determine the entity type.
REAL mass_props_array(noutputs, This data is returned on a per output (group or
VIRTUAL) entity) basis. The order of this array matches the
order of "entities" for "display" set to "Entity" or
the order of "groups" when "display" is set to
"Group". Array of mass properties, including, in
this order: (1) volume, (2) mass, (3-5) CG in
specified frame, (6-11) inertia tensor in specified
frame, (12-17) inertia tensor at CG in specified
frame, (18-20) principal inertias at CG, (21-29)
principal directions in specified frame, (30-32)
radii of gyration corresponding to the principal
inertias, (33-35) CG in reference Cartesian frame,
(36-41) inertia tensor in reference Cartesian
frame, (42-47) inertia tensor at CG in reference
Cartesian frame, (48-56) principal directions in
reference Cartesian frame, (57-59) principal
direction 3-2-1 space-fixed rotation angles from
specified frame, (60-62) principal direction 3-1-3
body-fixed rotation angles from specified frame,
(63-65) principal direction 3-2-1 space-fixed
rotation angles from reference Cartesian frame,
(66-68) principal direction 3-1-3 body-fixed
rotation angles from reference Cartesian frame,
(69) if bar then this is length, if shell this is surface
area, and if solid element then this value is
ignored. Symmetric tensors are in the order: XX,
XY, XZ, YY, YZ, ZZ.
STRING entity_list(VIRTUAL) This is a List Processor-recognizable list of all
entities specified. This is only valid if noutputs is
1 (such as display set to Summary).
INTEGER len_elist Length of string entity_list. Only used if Display
of Summary
INTEGER num_ents Number of entities in entity_list.Only used if
Display of Summary
STRING reject_list(VIRTUAL) List of input entities not included in mass property
calculations.
INTEGER len_rlist Length of string reject_list.Only used if Display
of Summary
466 PCL Reference Manual
Tools Menu
Messages:
If an error condition exists, then the diagnostics will be output and a reject list of the elements with
invalid properties will be generated. Some of the warnings and error messages are suppressed for
display by group and display by entity to avoid displaying a large number of duplicate error messages.
These warnings and errors can be seen by selecting the rejected element list and displaying by
summary.
Error Conditions:
Same as Error Conditions in mass_prop_create function
Description:
This function will write a set of mass properties and an entity list to a report file. The report file name
can be set through the Report... item of the File menu bar selection in the main form of Patran.
Input:
INTEGER file_columns This value specifies the number of columns in the
report. This value must be either 80 or 132.
REAL mass_properties(68) This value specifies the property information that
will be listed in the report. See the remarks below for
more information.
INTEGER coordinate_label This value specifies a label used to define a
coordinate frame against which the mass properties
were calculated.
Chapter 2: Basic Functions 467
Tools Menu
Remarks:
See the listing for the function mass_prop_create, 449 for further information on the inputs for this
function.
The output value mass_properties returns an array whose offsets contain the following information:
3-5 These offsets are used to return the center of gravity coordinates for the entities
used in the mass properties calculations in the specified coordinate frame.
6-11 These offsets are used to return the inertia tensor in the specified coordinate frame.
12-17 These offsets are used to return the inertia tensor at the center of gravity point in
the specified coordinate frame.
18-20 These offsets are used to return the principle axes of the moments of inertia at the
center of gravity point in the specified coordinate frame.
21-29 These offsets are used to return the direction for the principle axes of the moments
of inertia in the specified coordinate frame.
30-32 These offsets are used to return radii of gyration corresponding to the principal
inertial axes.
33-35 These offsets are used to return the center of gravity in the reference Cartesian
coordinate frame.
36-41 These offsets are used to return the inertia tensor in the reference Cartesian
coordinate frame.
42-47 These offsets are used to return the inertia tensor at the center of gravity in the
reference Cartesian coordinate frame.
48-56 These offsets are used to return the direction for the principle axes of the moments
of inertia in the reference Cartesian coordinate.
57-59 These offsets are used to return the principal directions for the axes of the moments
of inertia in the axes order 3-2-1 of the space fixed rotation angles from the
specified coordinate system.
60-62 These offsets are used to return the principal directions for the axes of the moments
of inertia in the axes order 3-1-3 of the body fixed rotation angles from the
specified coordinate system.
63-65 These offsets are used to return the principal directions for the axes of the moments
of inertia in the axes order 3-2-1 of the space fixed rotation angles from the
reference Cartesian coordinate frame.
66-68 These offsets are used to return the principal directions of the inertia tensors in the
axes order 3-1-3 of the body fixed rotation angles from the reference Cartesian
coordinate frame. These symmetric inertia tensors are in the axes order XX, XY,
XZ, YY, YZ, ZZ.
Description:
Write the mass properties and the entity lists generated by mass_prop_create_detailed to a report file.
Input:
INTEGER file_width Width of report file. Input 80 or 132
INTEGER noutputs If display from mass_prop_create_detailed is set
to "Entity", this is the number of unique entities
that have mass. If "display" is set to "Group", then
this is the number of groups. If the "display" is set
to "Summary", this value is equal to "1".
STRING display_method[] This determines how the results are displayed to
the spreadsheet. Either "Summary", "Group", or
"Entity"
STRING includes[] This region specifier, may be either Geometry,
FEM, or Both.
STRING groups[32](noutputs) If "display" is set to "Group", then this is an array
of group names in the region for mass properties.
If "display" is set to All or "Entity", this value is
ignored.
INTEGER entities(noutputs) The list of entity ids (not applicable if display is set
to Summary").
INTEGER entity_types(noutputs) The entity type corresponding to the entity given in
the entities array (not applicable if display is set
to Summary). These types are given in the
lpenums.i define file.
470 PCL Reference Manual
Tools Menu
Output:
None
INTEGER <Return Value> = 0 Function was successful
Side Effects:
Files: A Mass Properties report is written to the report file.
Error Conditions:
Error: Unable to allocate virtual memory.
Error Unable to write the Mass Properties report file. Failure occurred while attempting
to write.
Example:
None.
Description:
Free the mass properties arrays created by mass_prop_create.
Input:
REAL mass_props(VIRTUAL) Array of mass properties, including, in this order:
(1) volume, (2) mass, (3-5) CG in specified frame,
(6-11) inertia tensor in specified frame, (12-17)
inertia tensor at CG in specified frame, (18-20)
principal inertias at CG, (21-29) principal
directions in specified frame, (30-32) radii of
gyration corresponding to the principal inertias,
(33-35) CG in reference Cartesian frame, (36-41)
inertia tensor in reference Cartesian frame, (42-
47) inertia tensor at CG in reference Cartesian
frame, (48-56) principal directions in reference
Cartesian frame, (57-59) principal direction 3-2-1
space-fixed rotation angles from specified frame,
(60-62) principal direction 3-1-3 body-fixed
rotation angles from specified frame, (63-65)
principal direction 3-2-1 space-fixed rotation
angles from reference Cartesian frame, (66-68)
principal direction 3-1-3 body-fixed rotation
angles from reference Cartesian frame. Symmetric
tensors are in the order: XX, XY, XZ, YY, YZ, ZZ
472 PCL Reference Manual
Tools Menu
Example:
None.
Chapter 2: Basic Functions 473
Tools Menu
Description
Free the mass properties arrays created by mass_prop_create_detailed. This routine should be called
before an additional call to mass_prop_create_detailed to free the arrays.
Input:
REAL mass_props_array(noutput Array of mass properties, including, in this order: (1)
s,VIRTUAL) volume, (2) mass, (3-5) CG in specified frame, (6-11)
inertia tensor in specified frame, (12-17) inertia
tensor at CG in specified frame, (18-20) principal
inertias at CG, (21-29) principal directions in
specified frame, (30-32) radii of gyration
corresponding to the principal inertias, (33-35) CG in
reference Cartesian frame, (36-41) inertia tensor in
reference Cartesian frame, (42-47) inertia tensor at
CG in reference Cartesian frame, (48-56) principal
directions in reference Cartesian frame, (57-59)
principal direction 3-2-1 space-fixed rotation angles
from specified frame, (60-62) principal direction 3-1-
3 body-fixed rotation angles from specified frame,
(63-65) principal direction 3-2-1 space-fixed rotation
angles from reference Cartesian frame, (66-68)
principal direction 3-1-3 body-fixed rotation angles
from reference Cartesian frame, (69) if bar then this
is length, if shell this is surface area, and if solid
element then this value is ignored. Symmetric tensors
are in the order: XX, XY, XZ, YY, YZ, ZZ. noutputs
is the number of outputs returned from
mass_prop_create_detailed (ie. number of entities or
groups selected).
STRING entity_list[VIRTUAL] This is a List Processor-recognizable list of all
entities specified
STRING reject_list[VIRTUAL] List of input entities not included in mass property
calculations
Output:
None
Example:
None.
474 PCL Reference Manual
Tools Menu
Chapter 3: Geometry Functions
PCL Reference Manual
3 Geometry Functions
Introduction 476
Construct Actions 477
Disassemble Actions 779
Associate Actions 782
Disassociate Actions 790
Sweep Actions 796
Transform Actions 820
Edit Actions 896
Delete Actions 988
Utlities 999
476 PCL Reference Manual
Introduction
Introduction
This chapter documents functions that are used to implement the Geometry form accessed through the
switch bar.
This chapter presents function descriptions in six separate sections:
Construct Actions This section is used to describe some of the functions used to implement
the Construct or Create actions.
Disassemble Actions This section is used to describe some of the functions used to implement
the Disassemble actions.
Associate Actions This section is used to describe some of the functions used to implement
the Associate actions.
Disassociate Actions This section is used to describe some of the functions used to implement
the Disassociate actions.
Sweep Actions This section is used to describe some of the functions used to implement
the Sweep actions.
Transform Actions This section is used to describe some of the functions used to implement
the Transform actions.
Edit Actions This section is used to describe some of the functions used to implement
the Edit actions.
Delete Actions This section is used to describe some of the functions used to implement
the Delete actions.
Utlities
Chapter 3: Geometry Functions 477
Construct Actions
Construct Actions
This section is used to describe some of the functions used to implement the Construct or Create
actions.
Description:
This function creates a coordinate system from three specified points.
Input:
STRING output_labels[] This value specifies the labels of the coordinate
frame to be created.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER coordtype This value specifies the type of coordinate frame: 1
= rectangular, 2 = cylindrical, and 3 = spherical.
STRING point1[] This value specifies the origin of the new coordinate
frame.
STRING point2[] This value specifies a point on the Z axis of the new
coordinate frame.
STRING point3[] This value specifies a point on the X-Z plane of the
new coordinate frame.
Output:
STRING created_labels[VIRTUAL] This value returns the labels of the created
coordinate frame.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000064 Overwrite of existing entity not permitted.
1000211 The length of the Axis equals zero.
1000216 Unable to properly process the output labels.
1000302 The three points specified are nearly collinear.
Remarks:
This function displays the number of coordinate frames created and their labels.
478 PCL Reference Manual
Construct Actions
A coordinate frame will be created for each set of points. Each coordinate frame will be displayed in the
graphics window.
Example:
Please see asm_const_coord_3point (p. 381) in the PCL Reference Manual Examples.
Description:
This function creates coordinate systems from points on the reference coordinate frame.
Input:
STRING output_labels[] This value specifies the labels of the coordinate
frames to be created.
STRING plane[2] This value specifies which principle plane is defined
by Axis 1 and Axis 2:
Remarks:
This function displays the number of coordinate frames created and their labels.
A coordinate frame will be created for each set of points. Each coordinate frame will be displayed in the
graphics window.
Example:
Please see asm_const_coord_axis (p. 382) in the PCL Reference Manual Examples.
Description:
This function creates a coordinate system from an origin and three eular angles.
Input:
STRING output_labels[] This value specifies the labels of the coordinate
frame to be created.
INTEGER axis1 This value specifies the principal axis for the first
rotation.
INTEGER axis2 This value specifies the principal axis for the second
rotation.
INTEGER axis3 This value specifies the principal axis for the third
rotation.
REAL angle1 This value specifies the angle of the first rotation.
REAL angle2 This value specifies the angle of the second rotation.
REAL angle3 This value specifies the angle of the third rotation.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER coordtype This value specifies the type of coordinate frame: 1
= rectangular, 2 = cylindrical, and 3 = spherical.
STRING point1[] This value specifies the origin of the new coordinate
frame.
Output:
STRING created_labels[VIRTUAL] This value returns the labels of the coordinate frame
created.
480 PCL Reference Manual
Construct Actions
Remarks:
This function displays the number of coordinate frames created and their labels.
A coordinate frame will be created for each origin point. Each coordinate frame will be displayed in the
graphics window.
Example:
Please see asm_const_coord_euler (p. 383) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 481
Construct Actions
Description:
This function creates a rectangular coordinate system normal to a surface at a specified point.
Input:
STRING output_labels[] This value specifies the labels of the coordinate
frame to be created.
STRING surface[] This value specifies the reference surface.
INTEGER coordtype This value specifies the type of coordinate frame: 1
= rectangular, 2 = cylindrical, and 3 = spherical.
STRING point[] This value specifies a point or set of points that lie
on, or close to, the surface.
Output:
STRING created_labels[VIRTUAL] This value returns the labels of the coordinate frame
created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000001 Point %I% does not exist. Unable to continue.
1000005 Patch %I% does not exist. Unable to continue.
1000025 Error attempting to allocate virtual memory.
1000054 An invalid geometric entity type was used as input. The valid entity type to use is
%A%. Unable to process request.
1000064 Overwrite of existing entity not permitted.
1000211 The length of the Axis equals zero.
1000216 Unable to properly process the output labels.
1000232 The entity label value of %I% is invalid. Database assigning next highest available
label.
1000302 The three points specified are nearly collinear.
1000712 Unable to compute the tangent and normal vectors due to a non-removable
degeneracy or a singularity.
Remarks:
This function displays the number of coordinate frames created and their labels.
482 PCL Reference Manual
Construct Actions
A coordinate frame will be created for each point on or close to the surface. Each coordinate frame will
be displayed in the graphics window.
Example:
Please see asm_const_coord_normal (p. 384) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 483
Construct Actions
Description:
This function creates a rectangular coordinate system normal to a surface at a specified point. The x-
axis may coincide with the u or v parametric direction of the surface.
Input:
STRING output_labels[] This value specifies the labels of the coordinate frame to be
created.
STRING surface[] This value specifies the reference surface.
INTEGER coordtype This value specifies the type of coordinate frame: 1 =
rectangular, 2 = cylindrical, and 3 = spherical.
STRING point[] This value specifies a point or set of points that lie on, or
close to, the surface.
LOGICAL xaxis This value specifies whether the x-axis coincides with the
u-direction of the surface.
Remarks:
This function displays the number of coordinate frames created and their labels.
A coordinate frame will be created for each point on or close to the surface. Each coordinate frame will
be displayed in the graphics window.
Example:
None.
Chapter 3: Geometry Functions 485
Construct Actions
Description:
This function contructs circular arcs in a two-dimensional space, defined by a set of construction
planes, center point, a starting point, and an ending point.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
INTEGER num_curves This value specifies the number of curves per arc to
create.
INTEGER arc_angle This value specifies the arc angle to use: 1 =
minimum arc angle, and 2 = maximum arc angle.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING center_point_list[] This value specifies the list of points defining the
center point of the circular arc.
STRING start_point_list[] This value specifies the list of points defining the
starting point of the circular arc.
STRING end_point_list[] This value specifies the list of points defining the
ending point of the circular arc.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves defined by the input value num_curves will be created for each point input set.
Each curve created will be displayed in the graphics window.
486 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
1000578 The number of Curves per Arc must be greater than or equal to one. The invalid value
input was %I%.
38000413 Zero length plane normal vector.
38000424 The center point and start point define a zero radius.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_curve_2d_arc2point (p. 385) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 487
Construct Actions
Description:
This function creates an arc-shaped or parametric cubic curve in two dimensional space, defined by a
start point, midpoint, and an end point.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
INTEGER num_curves This value specifies the number of curves per arc to
create.
LOGICAL create_center This value is set to TRUE if a point is to be created
at the center of the arc.
STRING plane_list[] This value specifies the construction plane of the arc.
STRING start_list[] This value specifies the start point of the arc.
STRING mid_list[] This value specifies the midpoint of the arc.
STRING end_list[] This value specifies the end point of the arc.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves defined by the input value num_curves will be created for each set of three points.
Each curve will be displayed in the graphics window.
488 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
1000578 The number of Curves per Arc must be greater than or equal to one.
The invalid value input was %I%.
38000413 Zero length plane normal vector.
38000423 The three points specified are nearly collinear.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_curve_2d_arc3point (p. 386) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 489
Construct Actions
Description:
This function creates a circular-shaped or parametric cubic curve in two-dimensional space, defined by
a center point and a radius.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
INTEGER num_curves This value specifies the number of curves per circle
to create.
INTEGER radius_method This value specifies the method used to define a
radius: 1 = scalar radius value, and 2 = point location.
REAL radius This value specifies the radius of the circle if the
input value radius_method is set to 1.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING radius_point_list[] This value specifies the list of points defining the
radius of the circle if the input value radius_method
is set to 2.
STRING center_point_list[] This value specifies the list of points defining the
center point of the circle.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves defined by the input value num_curves will be created for each center point and
radius input set. Each curve created will be displayed in the graphics window.
490 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
1000579 The number of Curves per Circle must be greater than or equal to two.
The invalid value input was %I%.
38000413 Zero length plane normal vector.
38000425 The Circle radius must be greater than zero. Invalid value input was %G%.
38000426 The center point and start point define a zero radius.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_curve_2d_circle (p. 387) in the PCL Reference Manual Examples.
Description:
This function creates n circular-shaped or parametric cubic curves in two-dimensional space, defined
by a center point and a radius.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
INTEGER num_curves This value specifies the number of curves per circle
to create.
INTEGER radius_method This value specifies the method used to define a
radius: 1 = scalar radius value, and 2 = point location.
REAL radius This value specifies the radius of the circle if the
input value radius_method is set to 1.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING radius_point_list[] This value specifies the list of points defining the
radius of the circle if the input value radius_method
is set to 2.
STRING center_point_list[] This value specifies the list of points defining the
center point of the circle.
Chapter 3: Geometry Functions 491
Construct Actions
LOGICAL project_points This value specifies, when set to TRUE, that the
center points be projected onto the plane. When this
value is set to FALSE, the construction plane will be
translated to the center point location and will still be
parallel to the original plane.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves defined by the input value num_curves will be created for each center point and
radius input set. Each curve created will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000579 The number of Curves per Circle must be greater than or equal to two. The invalid
value input was %I%.
38000413 Zero length plane normal vector.
38000425 The Circle radius must be greater than zero. Invalid value input was %G%.
38000426 The center point and start point define a zero radius.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_curve_2d_circle (p. 387) in the PCL Reference Manual Examples.
492 PCL Reference Manual
Construct Actions
Description:
This function creates an arc-shaped or parametric cubic curve defined by a start point, midpoint, and
an end point.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER num_curves This value specifies the number of curves per arc
to create.
LOGICAL create_center This value is set to TRUE if a point is to be created
at the center of the arc.
STRING start_list[] This value specifies the start point of the curve.
STRING mid_list[] This value specifies the midpoint of the curve.
STRING end_list[] This value specifies the end point of the curve.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each set of three points. Each curve will be displayed in the graphics
window.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_curve_arc3point (p. 388) in the PCL Reference Manual Examples.
494 PCL Reference Manual
Construct Actions
Description:
This function creates a piecewise cubic curve from a set of points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER num_curves This value specifies the number of curves to create.
STRING point_list[] This value specifies the point list.
INTEGER order This value specifies the order of the B-spline.
LOGICAL interpolate This value is set to TRUE if the curve is to be
interpolated, and FALSE if the curve is to be
approximated.
INTEGER param_method This value specifies the parameterization method:
1 = chordal arc length, 2 = modified chordal arc
length, and 3 = uniform.
LOGICAL closed This value is set to TRUE if the curve is to be close.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves defined by the input value num_curves will be created for each point list. Each
curve will be displayed in the graphics window as it is created.
This function can display an information popup message form with the following messages:
Chapter 3: Geometry Functions 495
Construct Actions
This function can display a fatal popup message form with the following messages:
38000472 The number of points selected must be greater or equal to the order of the
B-spline curve.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_curve_bspline (p. 389) in the PCL Reference Manual Examples.
496 PCL Reference Manual
Construct Actions
Description:
This function creates a parametric cubic curve on a surface by extracting a curve from a given surface
at a specified position and in a specified parametric direction.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
STRING surface_list[] This value specifies the surface list.
INTEGER direction This value specifies the parametric direction to
create the curve in: 1 = constant U direction, and 2 =
constant V direction.
REAL param_pos This value specifies the parametric position in the
given direction from which to extract the curve.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve on a surface will be created for each surface and direction/param_pos set. Each curve will be
displayed in the graphics window as it is created.
This function can display a warning popup message form with the following message:
38000433 A Zero length curve would have been created had the process continued. Modify
application input and try again.
Chapter 3: Geometry Functions 497
Construct Actions
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000518 Specified Parametric Direction value of %I% is invalid. Valid values are 1 and 2.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_curve_extract (p. 390) in the PCL Reference Manual Examples.
Description:
This function creates a parametric cubic curve on a surface by extracting a curve from a given edge of
a surface or solid.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
STRING edge_list[] This value specifies the edge list.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and the IDs.
One curve will be created for each edge. Each curve will be displayed in the graphics window as it is
created.
498 PCL Reference Manual
Construct Actions
This function can display a warning popup message form with the following message:
1000054 An invalid geometric entity type was used as input. The valid entity type to use
is %A%. Unable to process request.
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_curve_extract_edge (p. 391) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 499
Construct Actions
Description:
This function creates a parametric cubic curve from the intersection of two surfaces or a plane and a
surface.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is set to an
empty string or to #, the function will automatically allocate
and assign a sequential list of curve IDs.
INTEGER method This value specifies the intersection method: 1 =
surface/surface intersection, and 2 = plane/surface
intersection.
STRING surface1_list[] This value specifies the first surface list if the input value
method is set to 1, and the plane list if the input value method
is set to 2.
STRING surface2_list[] This value specifies the second surface list.
INTEGER num_curves This value specifies the number of curves per intersection to
create.
REAL fit_tolerance This value specifies a tolerance parameter to be used as a
curve fit tolerance.
REAL int_tolerance This value specifies a tolerance parameter for determining the
density of intersection points generated.
Output:
STRING created_ids[VIRTU This value returns the created ID list.
AL]
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs. The number of
curves defined by the input value num_curves will be created for each intersection. Each curve will be
displayed in the graphics window.
500 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_curve_intersect (p. 392) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 501
Construct Actions
Description:
This function constructs finite length cubic lines from the intersection of two planes.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
REAL length This value specifies the length of the created lines.
STRING plane_list[] This value specifies the list of planes to be compared
for intersection with the planes given in the input
value plane2_list.
STRING plane2_list[] This value specifies the list of planes to be compared
for intersection with the planes provided by the input
value plane1_list.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One cubic line per intersection will be created for each plane input set. Each cubic line created will be
displayed in the graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
None.
Description:
This function constructs finite length cubic lines from the intersection of two planes with an option to
define the starting point of the line at a specified point where the three input planes intersect.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
REAL length This values specifies the length of the line.
STRING plane1_list[] This value specifies the list of planes to be compared
for intersection with the planes given in the input
value plane2_list.
STRING plane2_list[] This value specifies the list of planes to be compared
for intersection with the planes provided by the input
value plane1_list.
STRING plane3_list[] This value specifies the list of planes to be compared
for intersection with the planes provided by the input
value plane1_list and plane2_list. This creates the
intersection point for the start point of the line.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Chapter 3: Geometry Functions 503
Construct Actions
Remarks:
This function displays a message listing the number of curves created and their IDs.
One cubic line per intersection will be created for each plane input set. Each cubic line created will be
displayed in the graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
None.
504 PCL Reference Manual
Construct Actions
Description:
This function creates a parametric cubic curve defined as the unwinding of an imaginary string from a
circular bobbin.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is set to an
empty string or to #, the function will automatically allocate
and assign a sequential list of curve IDs.
STRING axis[] This value specifies the axis of the involute curve.
INTEGER option This value specifies the option to use in creating the involute.
If option = 1 the radii method is used, otherwise the angle
method is used.
REAL scalar1 This value specifies a scalar value depending on the value of
option. If the angle method is used, this is the angle to unwind
the curve. If the radii method is used, this is the base radius of
the bobbin.
REAL scalar2 This value specifies a scalar value depending on the value of
option. If the angle method is used, this is the starting angle of
the curve. If the radii method is used, this is the stop radius of
the curve.
INTEGER num_curves This value specifies the number of curves to create for each
point.
STRING coord_frame[] This value specifies the reference coordinate frame.
STRING point[] This value specifies the list of points to be swept.
Output:
STRING created_ids[VIRTU This value returns the created ID list.
AL]
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000054 An invalid geometric entity type was used as input. The valid entity type to use is
%A%. Unable to process request.
1000211 The length of the Axis equals zero.
1000226 The angle which the involute traverses must be positive.
1000227 The starting angle of the involute must be positive.
Chapter 3: Geometry Functions 505
Construct Actions
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves defined by the input value num_curves will be created for each point. Each curve
will be displayed in the graphics window.
Example:
Please see asm_const_curve_involute (p. 394) in the PCL Reference Manual Examples.
506 PCL Reference Manual
Construct Actions
Description:
This function create a piecewise cubic curve from a set of points with optional endpoint slope control.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
INTEGER num_curves This value specifies the number of curves to create.
LOGICAL slope_control This value is set to TRUE if the endpoint slope
control is to be enforced.
STRING point_list[] This value specifies the point list.
STRING slope_list1[] This value specifies the vectors defining the initial
slope.
STRING slope_list2[] This value specifies the vectors defining the final
slope.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves defined by the input value num_curves will be created for each point list. Each
curve will be displayed in the graphics window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_curve_loft (p. 395) in the PCL Reference Manual Examples.
508 PCL Reference Manual
Construct Actions
Description:
This function creates a parametric cubic curve on a surface between two points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING surface_list[] This value specifies the list of surfaces to manifold
the curve onto.
STRING point1_list[] This value specifies the list of points defining the
start point of the curve on a surface.
STRING point2_list[] This value specifies the list of points defining the
end point of the curve on a surface.
INTEGER num_curves This value specifies the number of curves per
manifold to create. If this value is set to 0, then the
number of curves created will be based on the
projection tolerance.
REAL fit_tolerance This value specifies a tolerance parameter which
will be used here as a curve fit tolerance. The
manifold will be approximated by a tolerance-
based cubic spline.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Chapter 3: Geometry Functions 509
Construct Actions
The number of curves defined by the input value num_curves will be created for each surface, point input
set. Each curve created will be displayed in the graphics window.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_curve_manifold_2point (p. 396) in the PCL Reference Manual Examples.
510 PCL Reference Manual
Construct Actions
Description:
This function creates a spline or parametric cubic curve through a specified number of points
manifolded onto a surface.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING surface[] This value specifies the surface to manifold the
curve onto.
STRING point_list[] This value specifies the list of points through
which the spline curve will be fitted.
INTEGER num_curves This value specifies the number of curves per
manifold to create. If this value is set to 0, then the
number of curves created will be based on the
projection tolerance.
REAL fit_tolerance This value specifies a tolerance parameter which
will be used here as a curve fit tolerance. The
manifold will be approximated by a tolerance-
based cubic spline.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves defined by the input value num_curves will be created for each surface, point input
set. Each curve created will be displayed in the graphics window.
Chapter 3: Geometry Functions 511
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
1000301 There must be at least two points as input. The invalid value input was %A%.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
38000489 Unable to create a curve manifolded to the surface between the two input points.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_curve_manifold_npoint (p. 397) in the PCL Reference Manual Examples.
Description:
This function creates a parametric cubic curve from the projection of curves onto surfaces.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING curve_list[] This value specifies the curve list to project.
STRING surface_list[] This value specifies the surface list to project onto.
LOGICAL delete_original This value is set to TRUE if the original curves to
project are to be deleted after the projection. If this
value is set to FALSE, the original entities will not
be deleted.
512 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves defined by the input value num_curves will be created for each projection. Each
curve will be displayed in the graphics window.
This function can display an information popup message form with the following message:
This function can display a warning popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_curve_project (p. 399) in the PCL Reference Manual Examples.
Description:
This function creates an arc shaped parametric cubic curve by revolving about a point.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to revolve each
point.
REAL offset This value specifies the initial offset angle.
STRING coord_frame[] This value specifies the reference coordinate frame.
STRING point[] This value specifies the list of points to be revolved.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
1000054 An invalid geometric entity type was used as input. The valid entity type to use is
%A%. Unable to process request.
1000064 Overwrite of existing entity not permitted.
1000210 Angle of rotation for a parametric entity is greater than 180 degrees.
514 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of curves created and their IDs.
More than one curve may be created for each point. Each curve will be displayed in the graphics window.
Example:
Please see asm_const_curve_revolve (p. 400) in the PCL Reference Manual Examples.
Description:
This function creates a point at the center of curvature of a curve.
Input:
STRING output_ids[] This value specifies the point ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of point IDs.
STRING curve_list[] This value specifies the curve which the center of
curvature will be calculated from to create the
point.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of planes created and their IDs.
One point will be created for each curve. Each point will be displayed in the graphics window as it is
created.
Chapter 3: Geometry Functions 515
Construct Actions
This function can display a warning popup message form with the following messages:
This function can display a fatal popup message form with the following message:
Example:
Please see asm_const_grid_arccenter (p. 401) in the PCL Reference Manual Examples.
Description:
This function constructs points by extracting a point from a curve at a specified parametric position.
Input:
STRING output_ids[] This value specifies the point ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
point IDs.
STRING curve_list[] This value specifies the list of curves from which to
extract points.
REAL param_pos This value specifies the parametric position along a
curve from which to extract a point.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
One point will be created for each parametric position specified along each curve. All points created will
be displayed in the graphics window.
516 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_grid_extract (p. 402) in the PCL Reference Manual Examples.
Description:
This function constructs points by extracting a point from a curve at a specified parametric position
and specifying a parameterization method for the input curve.
Input:
STRING output_ids[] This value specifies the point ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of point IDs.
STRING curve_list[] This value specifies the list of curves from which
to extract points.
REAL parametric_pos This value specifies the parametric position along
a curve from which to extract a point.
INTEGER param_method This value specifies the parameterization method
for input curve: 1 = equal relative arc length, and 2
= equal relative parametric values.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
Chapter 3: Geometry Functions 517
Construct Actions
One point will be created for each parametric position specified along each curve. All points created will
be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000507 Specified Parameterization Method value of %I% is invalid. Valid values are 1
and 2.
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_grid_extract_v1 (p. 403) in the PCL Reference Manual Examples.
Description:
This function constructs points by extracting a point from a surface at a specified u,v parametric
location.
Input:
STRING output_ids[] This value specifies the point ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
point IDs.
REAL uloc This value specifies the u-parametric position from
which to extract a point.
REAL vloc This value specifies v-parametric position from
which to extract a point.
STRING surface_list[] This value specifies the list of surfaces from which
to extract points.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
518 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of points created and their IDs.
One point will be created for each parametric position set specified per surface. All points created will
be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
2001070 Unable to acquire %I% words of virtual memory.
Example:
None.
Description:
This function constructs points by extracting n points from a surface within a u,v min/max grid.
Input:
STRING output_ids[] This value specifies the point ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
point IDs.
INTEGER npu This value specifies the number of points to create in
the u-direction.
INTEGER npv This value specifies the number of points to create in
the v-direction.
REAL uvmin_max(4) This value specifies the uv min/max parametric
values which define the bounds in which to extract
the points, where:
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
Points will be created for each entity list. All points created will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000313 The number of points to extract must be greater than one in both directions.
1000312 The MIN/MAX values are improper. They must lie in the unit interval.
2001070 Unable to acquire %I% words of virtual memory.
Example:
None.
Description:
This function constructs points by extracting n points from a surface within a grid defined by a
diagonal of two points.
Input:
STRING output_ids[] This value specifies the point ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of point IDs.
INTEGER npu This value specifies the number of points to create
in the u-direction.
INTEGER npv This value specifies the numbe of points to create
in the v-direction.
520 PCL Reference Manual
Construct Actions
STRING point1_list[] This value specifies the first point used to define
the diagonal for the bounds of the grid of points.
STRING point2_list[] This value specifies the second point used to define
the diagonal for the bounds of the grid of points.
STRING surface_list[] This value specifies the surface list to extract from.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
Points will be created for each entity list. All points created will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000313 The number of points to extract must be greater than one in both directions.
2001070 Unable to acquire %I% words of virtual memory.
Example:
None.
Chapter 3: Geometry Functions 521
Construct Actions
Description:
This function constructs points by interpolating along a curve.
Input:
STRING output_ids[] This value specifies the point ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
point IDs.
STRING curve_list[] This value specifies the curve list to interpolate.
REAL space_ratio This value specifies the point spacing ratio which is
the distance defined by the input value num_points
to the end point, divided by the distance defined by
the start point to the second point.
INTEGER num_points This value specifies the number of interior points to
create.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
Points will be created for each entity list. All points created will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000300 There must be at least one point as input. The invalid value input was %I%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_grid_interp_curve (p. 404) in the PCL Reference Manual Examples.
522 PCL Reference Manual
Construct Actions
Description:
This function constructs points by interpolating along a curve and specifying a parameterization
method for the input curve.
Input:
STRING output_ids[] This value specifies the point ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of point IDs.
STRING curve_list[] This value specifies the curve list to interpolate.
REAL space_ratio This value specifies the point spacing ratio which
is the distance defined by the input value
num_points to the end point, divided by the
distance defined by the start point to the second
point.
INTEGER num_points This value specifies the number of interior points
to create.
INTEGER param_method This value specifies the parameterization method
for the input curve: 1 = equal relative arc length,
and 2 = equal relative parametric values.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
Points will be created for each entity list. All points created will be displayed in the graphics window.
Chapter 3: Geometry Functions 523
Construct Actions
This function can display a fatal popup message form with the following messages:
1000300 There must be at least one point as input. The invalid value input was %I%.
1000507 Specified Parameterization Method value of %I% is invalid. Valid values are 1 and
2.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_grid_interp_curve_v1 (p. 406) in the PCL Reference Manual Examples.
Description:
This function constructs points by interpolating between two existing points.
Input:
STRING output_ids[] This value specifies the point ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of point IDs.
STRING point1_list[] This value specifies the first point list to
interpolate.
STRING point2_list[] This value specifies the second point list to
interpolate.
REAL space_ratio This value specifies the point spacing ratio which
is the distance defined by input value num_points
to the end point, divided by the distance defined by
the start point to the second point.
INTEGER num_points This value specifies the number of interior points
to create.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
524 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of points created and their IDs.
Points will be created for each point set list. All points created will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000300 There must be at least one point as input. The invalid value input was %I%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_grid_interp_point (p. 407) in the PCL Reference Manual Examples
Description:
This function creates points by interpolating between two existing points with the results manifolded
to a surface.
Input:
STRING output_ids[] This value specifies the point ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
point IDs.
STRING point1_list[] This value specifies the first point list.
STRING point2_list[] This value specifies the second point list.
STRING surface_list[] This value specifies the surface list to manifold the
points to.
REAL space_ratio This value specifies the point spacing ratio which is
the distance defined by input value num_points to
the end point, divided by the distance defined by the
start point to the second point.
REAL num_points This value specifies the number of interior points to
create.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Chapter 3: Geometry Functions 525
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs. One point will be
created for each set of points and manifold surface. Each point will be displayed in the graphics window.
This function can display a warning popup message form with the following message:
1000300 There must be at least one point as input. The invalid value input was %I%.
This function can display a fatal popup message form with the following message:
Example:
None
526 PCL Reference Manual
Construct Actions
Description:
This function creates a point from the intersection of two curves.
Input:
STRING output_ids[] This value specifies the point ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
point IDs.
STRING curve1_list[] This value specifies the first curve list.
STRING curve2_list[] This value specifies the second curve list.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
One point will be created for each set of curves. Each point will be displayed in the graphics window.
This function can display a warning popup message form with the following message:
1000580 The two input curves do not intersect within tolerance of %G%. The minimum
distance is %G%. A point of closest approach on each input curve was provided.
This function can display a fatal popup message form with the following message:
Example:
Please see asm_const_grid_intersect (p. 408) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 527
Construct Actions
Description:
This function creates a point from the intersection of a curve and a plane with an optional plane offset
distance.
Input:
STRING output_ids[] This value specifies the point ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of point IDs.
STRING curve_list[] This value specifies the curve list.
STRING plane_list[] This value specifies the plane list.
REAL offset This value specifies the plane offset distance.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in
the message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
One point will be created for each set of curve and plane that intersect. Each point will be displayed in
the graphics window.
This function can display a warning popup message form with the following message:
This function can display a fatal popup message form with the following message:
Example:
None.
528 PCL Reference Manual
Construct Actions
Description:
This function creates a point from the intersection of a vector and a plane with an optional plane offset
distance.
Input:
STRING output_ids[] This value specifies the point ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of point IDs.
STRING vector_list[] This value specifies the vector list.
STRING plane_list[] This value specifies the plane list.
REAL offset This value specifies the plane offset distance.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
One point will be created for each set of vector and plane that intersect. Each point will be displayed in
the graphics window.
This function can display a warning popup message form with the following message:
This function can display a fatal popup message form with the following message:
Example:
None
Chapter 3: Geometry Functions 529
Construct Actions
Description:
This function creates a point on an existing curve at an offset distance from an existing point on the
same curve.
Input:
STRING output_ids[] This value specifies the point ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
point IDs.
REAL distance This value specifies the offset distance along the
curve.
STRING point_list[] This value specifies the reference point on a curve
list.
STRING curvepoint_list[] This value specifies the curve to create the point on
and the point on the curve which indicates the end of
the curve closest to the new point to be created.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of plane created and their IDs.
One point will be created for each reference point. Each point will be displayed in the graphics window
as it is created.
This function can display a fatal popup message form with the following messages:
1000584 Invalid Distance value of %G% was input. Distance value must be between
%G% and %G%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_grid_offset (p. 409) in the PCL Reference Manual Examples.
Description:
This function constructs points at the intersection(s) of a curve with a surface.
Input:
STRING output_ids[] This value specifies the point ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of point IDs.
STRING curve_list[] This value specifies the curve list which intersects
with the surfaces in the surface list.
STRING surface_list[] This value specifies the surface list with which the
curves in the curve list intersect.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
Points will be created for each curve and surface intersection. All points created will be displayed in the
graphics window.
Chapter 3: Geometry Functions 531
Construct Actions
This function can display a fatal popup message form with the following messages:
1000541 No intersections found between projected curve(s) %A% onto surface(s) %A%.
2001070 Unable to acquire %I% words of virtual memory.
38000450 Unable to calculate a point on the curve.
Example:
Please see asm_const_grid_pierce (p. 410) in the PCL Reference Manual Examples.
532 PCL Reference Manual
Construct Actions
Description:
This function will create points by projecting other points to a surface.
Input:
STRING output_ids[] This value specifies the point ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
point IDs.
STRING point_list[] This value specifies the point list.
STRING surface_list[] This value specifies the surface list.
INTEGER etype This value specifies the geometry type to which the
points will be projected. Set this value to 1 to project
the points to surfaces. Set this value to 2 to project
the points to planes.
LOGICAL delete_orig This value specifies, when set to TRUE that the
original projected points are to be deleted. If this
value is set to FALSE, the original projected points
will not be deleted.
INTEGER project_method This value specifies the method of defining the
projection vector. Set this value to 1 to project points
along a normal to the surface. Set this value to 2 to
project points along a vector. Set this value to 3 to
project points along the view vector.
STRING vector[] This value specifies the rectangular coordinate
projection vector. This value is used only if the input
value project_method is set to 2.
Output:
STRING created_ids[VIRTUAL] This value returns id values for the projected points.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Chapter 3: Geometry Functions 533
Construct Actions
Remarks:
This function displays a message listing the number of points created and their id values.
One projected point will be created for each set of points and surfaces.
Each projected point will be displayed in the graphics window.
This function can display a warning popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
None.
Description:
This function constructs points based on their reference coordinate frame coordinates.
Input:
STRING output_ids[] This value specifies the point ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
point IDs.
STRING coordinates_list[] This value specifies the reference coordinate frame
coordinates of a point.
STRING coord_frame[] This value specifies the reference coordinate frame
in which to create the point. The default coordinate
frame is coordinate frame 0.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
534 PCL Reference Manual
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of points created and their IDs.
One point will be created for each set of point coordinates. Each point created will be displayed in the
graphics window.
This function can display a fatal popup message form with the following message:
Example:
Please see asm_const_grid_xyz (p. 411) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 535
Construct Actions
Description:
This function constructs hyperpatches from one surface to another, optionally lying within a manifold
solid.
Input:
STRING output_ids[] This value specifies the hyperpatch ID list. If this
value is set to an empty string or to #, the function
will automatically allocate and assign a sequential
list of hyperpatch IDs.
STRING surface1_list[] This value specifies the first set of surfaces for the
start of each hyperpatch.
STRING surface2_list[] This value specifies the second set of surfaces for the
end of each hyperpatch.
INTEGER manifold_type This value specifies the type of manifold entity: 0 =
no manifold, and 3 = solid manifold entity.
STRING manifold_id[] This value specifies the manifold entity.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the hyperpatch should be
automatically aligned.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of hyperpatches created and their IDs.
One hyperpatch will be created for each pair of input surfaces. Each hyperpatch will be displayed in the
graphics window as it is created.
The maximum manifold error will be displayed.
536 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
1000900 Specified Manifold Entity Type value of %I% is invalid. Valid values are 0 and 3.
1000901 Zero length vector in Hpat %I% construction.
1000905 An error occurred during the manifold operation for manifold solid %A%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_hpat_2surface (p. 412) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 537
Construct Actions
Description:
This function constructs hyperpatches which pass through three surfaces and one interior parametric
position.
Input:
STRING output_ids[] This value specifies the hyperpatch ID list. If this
value is set to an empty string or to #, the function
will automatically allocate and assign a sequential
list of hyperpatch IDs.
STRING surface1_list[] This value specifies the first set of surfaces for the
start of each hyperpatch.
STRING surface2_list[] This value specifies the second set of surfaces for the
middle of each hyperpatch.
STRING surface3_list[] This value specifies the third set of surfaces for the
end of each hyperpatch.
REAL param_pos This value specifies the value of the parametric
position of the middle surface. The default value is
0.5.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the hyperpatch should be
automatically aligned.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of hyperpatches created and their IDs.
One hyperpatch will be created for each set of three input surfaces. Each hyperpatch will be displayed in
the graphics window as it is created.
538 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000902 Unable to create an hpat with the specified parametric position value of %G%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_hpat_3surface (p. 414) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 539
Construct Actions
Description:
This function constructs hyperpatches which pass through four surfaces and two interior parametric
positions.
Input:
STRING output_ids[] This value specifies the hyperpatch ID list. If this
value is set to an empty string or to #, the function
will automatically allocate and assign a sequential
list of hyperpatch IDs.
STRING surface1_list[] This value specifies the first set of surfaces for the
start of each hyperpatch.
STRING surface2_list[] This value specifies the second set of surfaces for the
1/3 point of each hyperpatch.
STRING surface3_list[] This value specifies the third set of surfaces for the
2/3 point of each hyperpatch.
STRING surface4_list[] This value specifies the fourth set of surfaces for the
end of each hyperpatch.
REAL param_pos1 This value specifies the value of the parametric
position of the one third interior surface. The default
value is 0.333.
REAL param_pos2 This value specifies the value of the parametric
position of the two thirds interior surface. The
default value is 0.667.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the hyperpatch should be
automatically aligned.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
540 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of hyperpatches created and their IDs.
One hyperpatch will be created for each set of four input surfaces. Each hyperpatch will be displayed in
the graphics window as it is created.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000903 Unable to create an hpat with the specified parametric position values of %G% and
%G%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_hpat_4surface (p. 415) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 541
Construct Actions
Description:
This function constructs hyperpatches from six surfaces forming their exterior faces. The surfaces can
be in any order and have any parametric orientation, but they must define a valid exterior face of an
hyperpatch.
Input:
STRING output_ids[] This value specifies the hyperpatch ID list. If this
value is set to an empty string or to #, the function
will automatically allocate and assign a sequential
list of hyperpatch IDs.
STRING surface1_list[] This value specifies the first set of surfaces defining
face 1 of each hyperpatch.
STRING surface2_list[] This value specifies the second set of surfaces
defining face 2 of each hyperpatch.
STRING surface3_list[] This value specifies the third set of surfaces defining
face 3 of each hyperpatch.
STRING surface4_list[] This value specifies the fourth set of surfaces
defining face 4 of each hyperpatch.
STRING surface5_list[] This value specifies the fifth set of surfaces defining
face 5 of each hyperpatch.
STRING surface6_list[] This value specifies the sixth set of surfaces defining
face 6 of each hyperpatch.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of hyperpatches created and their IDs.
One hyperpatch will be created for each set of input surface faces. Each hyperpatch will be displayed in
the graphics windows as it is created.
542 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_hpat_face (p. 417) in the PCL Reference Manual Examples.
Description:
This function constructs trilinear hyperpatches from eight points. The points should be previously
defined and specified in the normal hyperpatch connectivity order.
Input:
STRING output_ids[] This value specifies the hyperpatch ID list. If this
value is set to an empty string or to #, the function
will automatically allocate and assign a sequential
list of hyperpatch IDs.
STRING point1_list[] This value specifies the first set of points defining
vertex 1 of each hyperpatch.
STRING point2_list[] This value specifies the second set of points defining
vertex 2 of each hyperpatch.
STRING point3_list[] This value specifies the third set of points defining
vertex 3 of each hyperpatch.
STRING point4_list[] This value specifies the fourth set of points defining
vertex 4 of each hyperpatch.
STRING point5_list[] This value specifies the fifth set of points defining
vertex 5 of each hyperpatch.
STRING point6_list[] This value specifies the sixth set of points defining
vertex 6 of each hyperpatch.
STRING point7_list[] This value specifies the seventh set of points
defining vertex 7 of each hyperpatch
STRING point8_list[] This value specifies the eighth set of points defining
vertex 8 of each hyperpatch.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
Chapter 3: Geometry Functions 543
Construct Actions
Remarks:.
This function displays a message listing the number of hyperpatches created and their IDs.
One hyperpatch will be created for each set of eight input vertices. Each hyperpatch will be displayed in
the graphics window as it is created.
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_hpat_vertex (p. 419) in the PCL Reference Manual Examples.
544 PCL Reference Manual
Construct Actions
Description:
This function constructs solids based on their X, Y, Z cartesian dimensions and origin.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING solid_length[] This value specifies the length of the hyperpatch in
X,Y,Z respectively.
STRING solid_origin[] This value specifies the X,Y,Z coordinates of the
origin of the solid respectively.
STRING coord_frame[] This value specifies the reference coordinate frame
in which to create the solid. The default coordinate
frame is coordinate frame 0.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each vector and solid origin set. All solids created will be displayed in the
graphics window.
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_hpat_xyz (p. 420) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 545
Construct Actions
Description:
This function constructs lines by ruling between two sets of points and within an manifold entity.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
line IDs.
STRING point1_list[] This value specifies the first set of points for the start
of each line.
STRING point2_list[] This value specifies the second set of points for the
end of each line.
INTEGER manifold_type This value specifies the type of manifold entity: 0 =
no manifold, 1 = line manifold entity, 2 = surface
manifold entity, and 3 = solid manifold entity.
STRING manifold_id[] This value specifies the manifold entity.
INTEGER num_interp This value specifies the number of points to define
the manifolding interpolation mesh through which is
fitted though the number of lines defined by the
input value num_lines.
INTEGER num_lines This value specifies the number of lines to create per
manifold.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
The maximum manifold error will be displayed.
546 PCL Reference Manual
Construct Actions
One line will be created for each pair of input points. Each line will be displayed in the graphics window
as it is created.
This function can display a fatal popup message form with the following messages:
1000511 Specified Manifold Entity Type value of %I% is invalid. Valid values are 0, 1, 2,
and 3.
1000554 An error occurred during the manifold operation for manifold curve %A%.
1000710 An error occurred during the manifold operation for manifold surface %A%.
1000905 An error occurred during the manifold operation for manifold solid %A%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_line_2point (p. 421) in the PCL Reference Manual Examples.
Description:
This function constructs lines which pass through three sets of points and an interior parametric
position.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is set to
an empty string or to #, the function will automatically
allocate and assign a sequential list of line IDs.
STRING point1_list[] This value specifies the first set of points for the start of
each line.
STRING point2_list[] This value specifies the second set of points for the
middle of each line.
STRING point3_list[] This value specifies the third set of points for the end of
each line.
INTEGER param_method This value specifies the parameterization method used to
parameterize the line: 1 = parametric position of
midpoint, and 2 = chord length parameterization.
REAL param_pos This value specifies the value of the parametric position
of the middle point if the input value param_method is set
to 1. The default value is 0.5.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
Chapter 3: Geometry Functions 547
Construct Actions
Remarks:
This function displays a message listing the number of lines created and their IDs.
One line will be created for each set of three input points. Each line will be displayed in the graphics
window as it is created.
This function can display a fatal popup message form with the following messages:
1000507 Specified Parameterization Method value of %I% is invalid. Valid values are 1 and
2.
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000509 Unable to create a line with the specified parametric position value of %G%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_line_3point (p. 422) in the PCL Reference Manual Examples.
Description:
This function constructs lines which pass through four sets of points and two interior parametric
positions.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of line IDs.
STRING point1_list[] This value specifies the first set of points for the
start of each line.
548 PCL Reference Manual
Construct Actions
STRING point2_list[] This value specifies the second set of points for the
1/3 point of each line.
STRING point3_list[] This value specifies the third set of points for the
2/3 point of each line.
STRING point4_list[] This value specifies the fourth set of points for the
end of each line.
INTEGER param_method This value specifies the parameterization method
used to parameterize the line: 1 = parametric
position of midpoint, and 2 = chord length
parameterization.
REAL param_pos1 This value specifies the value of the parametric
position of the one third interior point if the input
value param_method is set to 1. The default value
is 0.333.
REAL param_pos2 This value specifies the value of the parametric
position of the two thirds interior point if the input
value param_method is set to 1. The default value
is 0.667.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
One line will be created for each set of four input points. Each line will be displayed in the graphics
window as it is created.
This function can display a fatal popup message form with the following messages:
1000507 Specified Parameterization Method value of %I% is invalid. Valid values are 1 and
2.
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
Chapter 3: Geometry Functions 549
Construct Actions
1000510 Unable to create a line with the specified parametric position values of %G% and
%G%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_line_4point (p. 423) in the PCL Reference Manual Examples.
Description:
This function creates arcs through three sets of points.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
line IDs.
INTEGER num_lparc This value specifies the number of lines to create per
arc.
STRING point1_list[] This value specifies the list of points defining the
start of an arc.
STRING point2_list[] This value specifies the list of points defining the
midpoint of an arc.
STRING point3_list[] This value specifies the list of points defining the
end of an arc.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
A line will be created for each set of points. All lines created will be displayed in the graphics window.
550 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_line_arc3point (p. 425) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 551
Construct Actions
Description:
This function constructs a conic section such as a hyperbola, parabola, ellipse, or circular arc.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
line IDs.
STRING coord_frame[] This value specifies the reference coordinate frame
in which the construction point, defined by the input
value point1_list, is to be interpreted. The default
coordinate frame is coordinate frame 0.
REAL rho This value specifies the relative altitude value for the
conic section: Ellipse when 0.0 < rho < 0.5, Parabola
when rho = 0.5, Hyperbola when 0.5 < rho < 1.0.
STRING point1_list[] This value specifies the list of construction points,
which, in conjunction with the start and end points of
the conic section, define the plane and tangency of
the conic section.
STRING point2_list[] This value specifies the list of points defining the
start of the conic section.
STRING point3_list[] This value specifies the list of points defining the
end of the conic section.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
Curves will be created for each set of point lists. All lines created will be displayed in the graphics
window.
552 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following message:
Example:
Please see asm_const_line_conic (p. 426) in the PCL Reference Manual Examples.
Description:
This function constructs lines by extracting lines from a set of surfaces at a specified position and in
a specified parametric direction.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of line IDs.
STRING surface_list[] This value specifies the list of surfaces from which
lines are extracted.
INTEGER line_direction This value specifies the parametric direction in
which to create the line: 1 = C1 direction, and 2 =
C2 direction.
REAL param_pos This value specifies the value of the parametric
position in the given parametric direction from
which to extract the line.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
One line will be created for each parametric direction specified in each surface. Each line created will be
displayed in the graphics window.
Chapter 3: Geometry Functions 553
Construct Actions
This function can display a warning popup message form with the following message:
38000433 A Zero length curve would have been created had the process continued. Modify
application input and try again.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000518 Specified Parametric Direction value of %I% is invalid. Valid values are 1 and 2.
2001070 Unable to acquire %I% words of virtual memory.
38000637 Cannot access geometry definition for %A%.
Example:
Please see asm_const_line_extract (p. 427) in the PCL Reference Manual Examples.
Description:
This function constructs a fillet of a specified radius between any two lines.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is set to
an empty string or to #, the function will automatically
allocate and assign a sequential list of line IDs.
INTEGER num_fillet This value specifies the number of lines to create per
fillet.
REAL radius This value specifies the fillet radius.
REAL fil_tolerance This value specifies the fillet geometric tolerance.
LOGICAL trim_original This value is set to TRUE if the original line is to be
trimmed after the fillet is created.
STRING point1_list[] This value specifies the first fillet location list.
STRING point2_list[] This value specifies the second fillet location list.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
554 PCL Reference Manual
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
Curves will be created for each set of lines and points. All lines created will be displayed in the graphics
window.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
1000500 There must be at least one line as input. The invalid value input was %I%.
1000557 The fillet radius value is unacceptable. The radius value of %G% must be greater
than the fillet tolerance value of %G%.
1000558 The fillet line with radius %G% cannot be created between the two input curves.
1000571 The fillet curve has a zero angle of rotation. The fillet cannot be created.
1000572 The fillet curve has a zero radius. The fillet cannot be created.
2001070 Unable to acquire %I% words of virtual memory.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
Example:
Please see asm_const_line_fillet (p. 429) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 555
Construct Actions
Description:
This function creates a set of lines which together define a best fit to an arbitrary number of points.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of line IDs.
STRING point_list[] This value specifies the ordered list of points to
which the lines are to be fit.
INTEGER num_lines This value specifies the number of lines to fit
through the points in the point list.
REAL geo_tolerance This value specifies a geometric tolerance used to
test for convergence during the parametric least
squares numerical approximation. The default
value is 0.005.
INTEGER num_iterations This value defines the maximum number of times
to iterate during the parametric least squares
numerical approximation. The default value is 0.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
A line will be created for each point. All lines created will be displayed in the graphics window.
This function can display an information popup message form with the following messages:
1000517 The Line Construct parameter %A% was reset from the invalid input value of %I%
to the default value of %I%.
556 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_line_fit (p. 431) in the PCL Reference Manual Examples.
Description:
This function creates curves which at the intersection between two sets of surfaces.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
STRING surface1_list[] This value specifies the list of surfaces to be
compared for intersection with the surfaces in the
input value surface2_list.
STRING surface2_list[] This value specifies the list of surfaces to be
compared for intersection with the surfaces in the
input value surface1_list.
INTEGER curves_per_int This value specifies the number of curves to be
created per intersection.
REAL geo_tolerance This value specifies the maximum deviation
tolerance used during the creation of curves per
intersection curve.
REAL flat_tolerance This value specifies a tolerance parameter. Surfaces
in the input list are recursively subdivided until they
are planar within this tolerance. The default is
20*geo_tolerance.
Chapter 3: Geometry Functions 557
Construct Actions
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves per intersection defined by the input value curves_per_int will be created for each
surface input set. Each curve created will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_line_intersect (p. 432) in the PCL Reference Manual Examples.
558 PCL Reference Manual
Construct Actions
Description:
This function constructs lines which pass through a point perpendicular to set of lines.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of line IDs.
STRING point_list[] This value specifies the list of points from which
the perpendicular lines will be constructed.
STRING line_list[] This value specifies the list of lines to which the
perpendicular lines will be constructed.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
One line will be created for each point and line in the set of points and lines. All lines created will be
displayed in the graphics window.
This function can display a fatal popup message form with the following message:
Example:
Please see asm_const_line_normal (p. 433) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 559
Construct Actions
Description:
This function constructs lines by projecting lines along a plane normal or vector onto a set of surfaces.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
line IDs.
STRING line_list[] This value specifies the list of lines to project onto
the list of surfaces.
STRING surface_list[] This value specifies the list of surfaces onto which
the lines are to be projected.
LOGICAL delete_original This value is set to TRUE if the original lines to
project are to be deleted after the projection. If this
value is set to FALSE, the original entities will not
be deleted.
INTEGER project_method This value specifies the method of defining the
projection vector: 1 = the lines to be projected lie in
a plane and it is desirable to project the lines normal
to this plane, and 2 = the direction of projection is to
be given by a vector.
STRING vector[] This value specifies the projection vector if the input
value project_method is set to 2.
STRING coord_frame[] This value specifies the coordinate frame ID number
for the projection vector.
INTEGER num_lines This value specifies the number of lines to be created
per projection.
REAL geo_tolerance This value specifies the maximum deviation
tolerance used during the creation of the lines per
projection vector.
REAL flat_tolerance This value specifies a tolerance parameter. Surfaces
in the input list are recursively subdivided until they
are planar within this tolerance. The default is
20*geo_tolerance.
560 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of lines created and their IDs. It will also display a
message giving the maximum error found between the intersection points and the lines.
The number of lines per intersection defined by the input value num_lines will be created for each line
and surface input set. Each line created will be displayed in the graphics window.
This function can display a warning popup message form with the following message:
1000541 No intersections found between projected curve(s) %A% onto surface(s) %A%.
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_line_project (p. 434) in the PCL Reference Manual Examples.
Description:
This function constructs lines by projecting lines along a plane normal or vector onto a set of surfaces.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
line IDs.
STRING line_list[] This value specifies the list of lines to project onto
the list of surfaces.
STRING surface_list[] This value specifies the list of surfaces onto which
the lines are to be projected.
LOGICAL delete_original This value is set to TRUE if the original lines to
project are to be deleted after the projection. If this
value is set to FALSE, the original entities will not
be deleted.
INTEGER project_method This value specifies the method of defining the
projection vector: 1 = the lines to be projected lie in
a plane and it is desired to project the lines normal to
this plane, 2 = the direction of projection is normal
to the surface at the point of closest approach, and 3
= the direction of projection is to be given by a
vector.
STRING vector[] This value specifies the projection vector if the input
value project_method is set to 3.
STRING coord_frame[] This value specifies the coordinate frame ID number
for the projection vector.
REAL projection_tolerance This value specifies a tolerance parameter. The
algorithm creates all lines along the projected
surface so that the maximum distance lies between
them is the distance defined by this value.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
562 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of lines created and their IDs. It will also display a
message giving the maximum error found between the intersection points and the lines.
The number of lines per intersection defined by the input value num_lines will be created for each line
and surface input set. Each line created will be displayed in the graphics window.
This function can display an information popup message form with the following message:
This function can display a warning popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_line_project_v1 (p. 436) in the PCL Reference Manual Examples.
Description:
This function constructs a piecewise linear set of lines between a list of points.
Input:
Chapter 3: Geometry Functions 563
Construct Actions
STRING output_ids[] This value specifies the line ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
line IDs.
STRING point_list[] This value specifies the ordered list of points
defining the piecewise linear lines.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
Curves will be created for each set of point lists. All lines created will be displayed in the
graphics window.
This function can display a fatal popup message form with the following messages:
1000301 There must be at least two points as input. The invalid value input was %A%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_line_pwl (p. 438) in the PCL Reference Manual Examples.
Description:
This function constructs a piecewise cubic spline which passes through at least three points. Boundary
conditions at the two ends are controllable by the user.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
line IDs.
564 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of lines created and their IDs.
A spline line will be created for each set of point lists. All spline lines created will be displayed in the
graphics window.
This function can display a fatal popup message form with the following messages:
1000520 There must be at least two lines input for a Spline Line. The invalid value input
was %I%.
1000521 There must be at least three points input for a Spline Line. The invalid value input
was %A%.
1000523 The number of points (%I%) is insufficient for the Number of Spline Segments
(%I%) to create. There must be at least one more point than the number of
segments.
1000524 Duplicate points on Spline Line.
1000525 The points used to create the Spline Line are too close.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_line_spline (p. 438) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 565
Construct Actions
Description:
This function constructs tangents between two sets of lines with a parametric direction common to
that of the first set of lines.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of line IDs.
STRING line1_list[] This value specifies the first set of lines from
which tangential lines are created.
STRING line2_list[] This value specifies the second set of lines from
which tangential lines are created.
LOGICAL trim_original This value is set to TRUE if the original line is to
be trimmed after the tangent is created.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
Curves will be created for each set of line point lists. All lines created will be displayed in the graphics
window.
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_line_tancurve (p. 439) in the PCL Reference Manual Examples.
Description:
This function constructs tangential lines between sets of points and lines with the parametric direction
of the tangents being common to the lines.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
line IDs.
STRING line_list[] This value specifies the list of lines to which the
tangential lines are created.
STRING point_list[] This value specifies the list of points from which the
tangential lines are created.
LOGICAL closest_only This value is set to TRUE if the closest tangent is the
only tangent to be created if multiple tangents exist.
LOGICAL trim_original This value is set to TRUE if the original line is to be
trimmed after the tangent is created.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
Chapter 3: Geometry Functions 567
Construct Actions
A line will be created for each point and line in the point and line lists. All lines created will be displayed
in the graphics window.
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_line_tanpoint (p. 441) in the PCL Reference Manual Examples.
Description:
This function constructs lines based on their X, Y, Z cartesian dimensions and origin.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
line IDs.
STRING line_length[] This value specifies the length of the line in the X, Y,
and Z axes.
STRING line_origin[] This value specifies the X, Y, and Z coordinates of
the origin of the line.
STRING coord_frame[] This value specifies the reference coordinate frame
in which to create the point. The default coordinate
system used is coordinate frame 0.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
568 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of lines created and their IDs.
One line will be created for each vector and line origin set. All lines created will be displayed in the
graphics window.
This function can display a fatal popup message form with the following message:
Example:
Please see asm_const_line_xyz (p. 442) in the PCL Reference Manual Examples.
Description:
This function constructs patches from one set of curves to another, optionally lying within a manifold
surface or solid.
Input:
STRING output_ids[] This value specifies the patch ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
patch IDs.
STRING curve1_list[] This value specifies the first set of curves from which
each patch is started.
STRING curve2_list[] This value specifies the second set of curves defining
the end of each patch.
INTEGER manifold_type This value specifies the type of manifold entity: 0 = no
manifold, 2 = surface manifold entity, and 3 = solid
manifold entity.
STRING manifold_id[] This value specifies the manifold entity.
INTEGER ruled_form This value specifies the ruled patch parameterization
form: 0 = equal relative arc length, and1 = equal
relative parameter values.
LOGICAL auto_align This value specifies, when set to TRUE, will designate
that the curves used to construct the patch should be
automatically aligned.
Chapter 3: Geometry Functions 569
Construct Actions
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of patches created and their IDs.
One patch will be created for each pair of input curves. Each patch will be displayed in the graphics
window as it is created.
The maximum manifold error will be displayed.
This function can display a fatal popup message form with the following messages:
1000573 Curve %I% does not have the required Company of Origin (PDA Engineering) to
construct a Line using the %A% Option. Unable to continue.
1000702 Specified Manifold Entity Type value of %I% is invalid. Valid values are 0, 2, and 3.
1000710 An error occurred during the manifold operation for manifold surface %A%.
1000905 An error occurred during the manifold operation for manifold solid %A%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_patch_2curve (p. 443) in the PCL Reference Manual Examples.
570 PCL Reference Manual
Construct Actions
Description:
This function constructs patches from one set of curves to another, optionally lying within a manifold
surface or solid.
Input:
STRING output_ids[] This value specifies the patch ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
patch IDs.
STRING curve1_list[] This value specifies the first set of curves from which
each patch is started.
STRING curve2_list[] This value specifies the second set of curves defining
the end of each patch.
INTEGER manifold_type This value specifies the type of manifold entity: 0 = no
manifold, 2 = surface manifold entity, and 3 = solid
manifold entity.
STRING manifold_id[] This value specifies the manifold entity.
LOGICAL auto_align This value specifies, when set to TRUE, that the curves
used to construct the patch should be automatically
aligned.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of patches created and their IDs.
One patch will be created for each pair of input curves. Each patch will be displayed in the graphics
window as it is created.
The maximum manifold error will be displayed.
Chapter 3: Geometry Functions 571
Construct Actions
This function can display a fatal popup message form with the following messages:
1000702 Specified Manifold Entity Type value of %I% is invalid. Valid values are 0, 2, and 3.
1000710 An error occurred during the manifold operation for manifold surface %A%.
1000905 An error occurred during the manifold operation for manifold solid %A%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_patch_2curve_v1 (p. 444) in the PCL Reference Manual Examples.
Description:
This function constructs patches which pass through three sets of curves and an interior parametric
position.
Input:
STRING output_ids[] This value specifies the patch ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
patch IDs.
STRING curve1_list[] This value specifies the first set of curves from
which each patch is started.
STRING curve2_list[] This value specifies the second set of curves defining
a midpoint on each patch.
STRING curve3_list[] This value specifies the third set of curves defining
the end of each patch.
REAL param_pos This value specifies the value of the parametric
position of the middle curve. The default value is
0.5.
LOGICAL auto_align This value specifies, when set to TRUE, that the
curves used to construct the patch should be
automatically aligned.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
572 PCL Reference Manual
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of patches created and their IDs.
One patch will be created for each triple of input curves. Each patch will be displayed in the graphics
window as it is created.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000703 Unable to create a patch with the specified parametric position value of %G%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_patch_3curve (p. 445) in the PCL Reference Manual Examples.
Description:
This function constructs patches which pass through four sets of curves and two interior parametric
positions.
Input:
STRING output_ids[] This value specifies the patch ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
patch IDs.
STRING curve1_list[] This value specifies the first set of curves from
which each patch is started.
STRING curve2_list[] This value specifies the second set of curves defining
the first midpoint on each patch.
STRING curve3_list[] This value specifies the third set of curves defining
the second midpoint on each patch.
STRING curve4_list[] This value specifies the fourth set of curves defining
the end of each patch.
Chapter 3: Geometry Functions 573
Construct Actions
Remarks:
This function displays a message listing the number of patches created and their IDs.
One patch will be created for each set of four input curves. Each patch will be displayed in the graphics
window as it is created.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000704 Unable to create a patch with the specified parametric position values of %G% and
%G%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_patch_4curve (p. 447) in the PCL Reference Manual Examples.
574 PCL Reference Manual
Construct Actions
Description:
This function constructs patches from four bounding curves, and optionally lying within a manifold
surface or solid.
Input:
STRING output_ids[] This value specifies the patch ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of patch IDs.
STRING curve1_list[] This value specifies a set of curves defining the
first edge of each patch.
STRING curve2_list[] This value specifies a set of curves defining the
second edge of each patch.
STRING curve3_list[] This value specifies a set of curves defining the
third edge of each patch.
STRING curve4_list[] This value specifies a set of curves defining the
fourth edge of each patch.
INTEGER manifold_type This value specifies the type of manifold entity: 0
= no manifold, 2 = surface manifold entity, and 3 =
solid manifold entity.
STRING manifold_id[] This value specifies the manifold entity.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of patches created and their IDs.
One patch will be created for each set of four input edge curves. Each patch will be displayed in the
graphics window as it is created.
Chapter 3: Geometry Functions 575
Construct Actions
This function can display a fatal popup message form with the following messages:
1000702 Specified Manifold Entity Type value of %I% is invalid. Valid values are 0, 2, and 3.
1000709 Unable to intersect the curves being used to construct a patch. The curves must form
a closed region and must be in a circular order.
1000710 An error occurred during the manifold operation for manifold surface %A%.
1000905 An error occurred during the manifold operation for manifold solid %A%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_patch_edge (p. 449) in the PCL Reference Manual Examples.
Description:
This function constructs patches by extracting patches from hyperpatches at a specified parametric
position and in a specified parametric direction.
Input:
STRING output_ids[] This value specifies the patch ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of patch IDs.
STRING hpat_list[] This value specifies the list of hyperpatches to
extract patches from.
INTEGER param_plane This value specifies the constant parametric plane
in which to create the patch: 1 = constant C1 plane,
2 = constant C2 plane, and 3 = constant C3 plane.
REAL param_pos This value specifies the parametric position in the
given parametric plane from which to extract the
patch.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
576 PCL Reference Manual
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of patches created and their IDs.
One patch will be created for each parametric plane specified in each hyperpatch. Each patch created will
be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000705 Specified Parametric Plane value of %I% is invalid. Valid values are 1, 2, and 3.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_patch_extract (p. 450) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 577
Construct Actions
Description:
This function constructs a fillet patch with a specified radii between any two patches.
Input:
STRING output_ids[] This value specifies the patch ID list. If this value is set to
an empty string or to #, the function will automatically
allocate and assign a sequential list of patch IDs.
REAL radius1 This value specifies the fillet radius.
REAL radius2 This value specifies the second radius for a varying radius
fillet that is created with the first edge beginning at a
radius defined by the input value radius1 and gradually
varying to match the input value radius2 at the opposite
edge.
REAL fil_tolerance This value specifies the fillet geometric tolerance.
LOGICAL trim_original This value is set to TRUE if the original patch is to be
trimmed after the fillet is created.
STRING point1_list[] This value specifies the first set of locations for the fillets
on a set of patches.
STRING point2_list[] This value specifies the second set of locations for the
fillets on a set of patches.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of patches created and their IDs.
This function will create fillet patches for each set of positions on patches listed. All patches created will
be displayed in the graphics window.
578 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_patch_fillet (p. 451) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 579
Construct Actions
Description:
This function constructs patches with common boundaries or matching edges from patches with two
consecutive common vertices but unmatched edges. The input patches need not have matching
parametric orientations.
Input:
STRING output_ids[] This value specifies the patch ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
patch IDs.
STRING patch_list1[] This value specifies the list of patches to which the
new patches will be matched.
STRING patch_list2[] This value specifies the list of patches to match with
the patches in the first patch list.
LOGICAL delete_original This value is set to TRUE if the original patches are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of patches created and their IDs.
One patch will be created for each pair of input patches. Each patch will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_patch_match (p. 453) in the PCL Reference Manual Examples.
Description:
This function constructs quadrilateral patches formed by four vertex points and are optionally lying
within a manifold surface or solid.
Input:
STRING output_ids[] This value specifies the patch ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of patch IDs.
STRING point1_list[] This value specifies the set of points defining the
first vertex of each patch.
STRING point2_list[] This value specifies the set of points defining the
second vertex of each patch.
STRING point3_list[] This value specifies the set of points defining the
third vertex of each patch.
STRING point4_list[] This value specifies the set of points defining the
fourth vertex of each patch.
INTEGER manifold_type This value specifies the type of manifold entity: 0
= no manifold, 2 = surface manifold entity, and 3 =
solid manifold entity.
Chapter 3: Geometry Functions 581
Construct Actions
Remarks:
This function displays a message listing the number of patches created and their IDs.
One patch will be created for each set of four input vertex points. Each patch will be displayed in the
graphics window as it is created.
This function can display a fatal popup message form with the following messages:
1000702 Specified Manifold Entity Type value of %I% is invalid. Valid values are 0, 2, and 3.
1000710 An error occurred during the manifold operation for manifold surface %A%.
1000905 An error occurred during the manifold operation for manifold solid %A%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_patch_vertex (p. 454) in the PCL Reference Manual Examples.
582 PCL Reference Manual
Construct Actions
Description:
This function constructs patches based on dimensions and an origin point in a cartesian coordinate
system.
Input:
STRING output_ids[] This value specifies the patch ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of patch IDs.
STRING patch_length[] This value specifies the length of the patch in yjr X,
Y, snf Z axes, respectively.
STRING patch_origin[] This value specifies the X, Y, and Z coordinates of
the origin of the patch, respectively.
STRING coord_frame[] This value specifies the reference coordinate frame
in which to create the patch. The default coordinate
frame is coordinate frame 0.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of patches created and their IDs.
One patch will be created for each set of origin and dimensional inputs. All patches created will be
displayed in the graphics window.
This function can display a fatal popup message form with the following message:
Example:
Please see asm_const_patch_xyz (p. 455) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 583
Construct Actions
Description:
This function creates parametric tricubic or wedge shaped solids from sets of five surfaces defining
their exterior faces. The surfaces can be in any order and have any parametric orientation but they must
define a valid exterior face of a solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
solid IDs.
STRING surface1_list[] This value specifies the set of surfaces defining the
first face of each solid.
STRING surface2_list[] This value specifies the set of surfaces defining the
second face of each solid.
STRING surface3_list[] This value specifies the set of surfaces defining the
third face of each solid.
STRING surface4_list[] This value specifies the set of surfaces defining the
forth face of each solid.
STRING surface5_list[] This value specifies the set of surfaces defining the
fifth face of each solid.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each set of input surfaces. Each solid will be displayed in the graphics
window as it is created.
584 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_solid_5face (p. 456) in the PCL Reference Manual Examples.
Description:
This function creates parametric tricubic or wedge shaped solids from sets of six surfaces defining
their exterior faces. The surfaces can be in any order and have any parametric orientation but they
must define a valid exterior face of a solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
solid IDs.
STRING surface1_list[] This value specifies the set of surfaces defining the
first face of each solid.
STRING surface2_list[] This value specifies the set of surfaces defining the
second face of each solid.
STRING surface3_list[] This value specifies the set of surfaces defining the
third face of each solid.
STRING surface4_list[] This value specifies the set of surfaces defining the
forth face of each solid.
STRING surface5_list[] This value specifies the set of surfaces defining the
fifth face of each solid.
STRING surface6_list[] This value specifies the set of surfaces defining the
sixth face of each solid.
Chapter 3: Geometry Functions 585
Construct Actions
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in
the message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each set of input surfaces. Each solid will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_solid_6face (p. 458) in the PCL Reference Manual Examples.
586 PCL Reference Manual
Construct Actions
Description:
This function creates parametric tricubic or wedge shaped solids by moving surfaces through space
along a defined axis with the option of scaling and rotating simultaneously.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING delta[] This value specifies a translation vector defining
the direction and magnitude of the extrusion
operation.
REAL scale This value specifies the scaling factor.
REAL angle This value specifies the angle to rotate the surface
around the translation vector during the extrusion
operation.
STRING origin[] This value specifies the point of origin from which
the extrusion operation will take place.
STRING coord_frame[] This value specifies the reference coordinate
frame.
INTEGER num_solids This value specifies the number of solids to create
for each surface.
STRING surface_list[] This value specifies the list of surfaces to be
extruded.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000211 The length of the Axis equals zero.
1000241 Unable to extrude hyperpatch because the surface is too degenerate.
38000118 An attempt to approximate a general surface with a single Parametric BiCubic
failed.
Chapter 3: Geometry Functions 587
Construct Actions
Remarks:
This function displays a message listing the number of solids created and their IDs.
The number of solids defined by the input value num_solids will be created for each input surface. Each
solid will be displayed in the graphics window.
Example:
Please see asm_const_solid_extrude (p. 459) in the PCL Reference Manual Examples.
588 PCL Reference Manual
Construct Actions
Description:
This function creates parametric tricubic or wedge shaped solids by revolving surfaces about an axis
of rotation.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
REAL scale This value specifies the scaling factor.
INTEGER glide_option This value specifies the glide option to use: 0 =
normal project glide option, and 1 = fixed logic
option.
STRING director_surface[] This value specifies the list of surfaces along
which the base surface will be swept.
STRING base_surface[] This value specifies the list of surfaces that will be
swept along the director surfaces to form the
solids.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000225 Unable to do glide option.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
38000117 An attempt to approximate a general curve with a single Parametric Cubic failed.
38000118 An attempt to approximate a general surface with a single Parametric BiCubic
failed.
38000121 Invalid format conversion flag specified for surface conversion.
Remarks:
This function displays a message listing the number of solids created and their IDs.
Chapter 3: Geometry Functions 589
Construct Actions
One solid will be created for each set of base_surfaces and director_surfaces. If there are m base_surfaces
and n director_surfaces, m*n solids will be created. Each solid will be displayed in the graphics window.
Example:
Please see asm_const_solid_glide (p. 461) in the PCL Reference Manual Examples.
590 PCL Reference Manual
Construct Actions
Description:
This function creates parametric tricubic or wedge shaped solids which are defined by a set of base
surfaces and an offset from those surfaces in the direction of the curvature. The offset may be constant
or a linear taper.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
solid IDs.
STRING thickness1[] This value specifies the constant thickness or the
first thickness at u=0; v=0.
STRING thickness2[] This value is set to NULL if the input value
thickness1 is set to constant thickness, otherwise it
is the second thickness at u=0; v=1.
STRING thickness3[] This value is set to NULL if he input value
thickness1 is
set to constant thickness, otherwise it is the third
thickness at u=1; v=1.
STRING thickness4[] This value is set to NULL if he input value
thickness1 is
set to constant thickness, otherwise it is the fourth
thickness at u=1; v=0.
INTEGER num_solids This value specifies the number of solids to be
created from each surface.
LOGICAL normal_rev_direction This value is set to TRUE if the normal is to be
flipped or reversed.
STRING surface_list[] This value specifies the list of surfaces to be swept
using the normal option.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
Chapter 3: Geometry Functions 591
Construct Actions
1000712 Unable to compute the tangent and normal vectors due to a non-removable
degeneracy or a singularity.
1000901 Zero length vector in Hpat %I% construction.
16000301 Blank string encountered.
16000302 %A% does not contain enough arguments, looking for %I% arguments.
16000303 %A% has too many arguments, looking for %I% arguments.
16000305 %A% is not a real.
38000118 An attempt to approximate a general surface with a single Parametric BiCubic failed.
38000121 Invalid format conversion flag specified for surface conversion.
38000427 The surface type used for this Action, Object, Method function is invalid. It must be
of a type that when created, has the default color of Green.
Remarks:
The number of solids defined by the input value num_solids will be created for each surface. Each solid
will be displayed in the graphics window.
Example:
Please see asm_const_solid_normal (p. 462) in the PCL Reference Manual Examples.
592 PCL Reference Manual
Construct Actions
Description:
This function creates parametric tricubic or wedge shaped solids by revolving surfaces about an axis
of rotation.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
solid IDs.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to revolve each
surface in degrees.
REAL offset This value specifies the initial offset angle in
degrees.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_solids This value specifies the number of solids to create
for each surface.
STRING surface_list[] This value specifies the list of surfaces to be
revolved.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000210 Angle of rotation for a parametric entity is greater than 180 degrees.
1000211 The length of the Axis equals zero.
1000242 Rotation is approximately parallel to the surface.
1000901 Zero length vector in Hpat %I% construction.
38000118 An attempt to approximate a general surface with a single Parametric BiCubic
failed.
38000121 Invalid format conversion flag specified for surface conversion.
38000427 The surface type used for this Action, Object, Method function is invalid. It must
be of a type that when created, has the default color of Green.
Chapter 3: Geometry Functions 593
Construct Actions
Remarks:
This function displays a message listing the number of solids created and their IDs.
The number of solids defined by the input value num_solids will be created for each surface. Each solid
will be displayed in the graphics window.
Example:
Please see asm_const_solid_revolve (p. 463) in the PCL Reference Manual Examples.
Description:
This function creates parametric tricubic or wedge shaped solids from one set of surfaces to another.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
solid IDs.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the solid should be
automatically aligned.
STRING surface1_list[] This value specifies the first set of surfaces for the
start of each solid.
STRING surface2_list[] This value specifies the second set of surfaces for the
end of each solid.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each pair of input surfaces. Each solid will be displayed in the graphics
window as it is created.
594 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_solid_2surface (p. 465) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 595
Construct Actions
Description:
This function creates parametric tricubic or wedge shaped solids from three sets of surfaces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
solid IDs.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the solid should be
automatically aligned.
INTEGER param_method This value specifies the parameterization method to
use: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING surface1_list[] This value specifies the first list of surfaces.
STRING surface2_list[] This value specifies the second list of surfaces.
STRING surface3_list[] This value specifies the third list of surfaces.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each pair of input surfaces. Each solid will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
1000507 Specified Parameterization Method value of %I% is invalid. Valid values are 1 and
2.
1000902 Unable to create an hpat with the specified parametric position value of %G%.
38000118 An attempt to approximate a general surface with a single Parametric BiCubic failed.
38000121 Invalid format conversion flag specified for surface conversion.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_solid_3surface (p. 466) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 597
Construct Actions
Description:
This function creates parametric tricubic or wedge shaped solids from four sets of surfaces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
solid IDs.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the solid should be
automatically aligned.
INTEGER param_method This value specifies the parameterization method to
use: 1 = chord length parameterization, and 2 = uniform
parameterization.
STRING surface1_list[] This value specifies the first list of surfaces.
STRING surface2_list[] This value specifies the second list of surfaces.
STRING surface3_list[] This value specifies the third list of surfaces.
STRING surface4_list[] This value specifies the fourth list of surfaces.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each set of input surfaces. Each solid will be displayed in the graphics
window as it is created.
598 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
1000507 Specified Parameterization Method value of %I% is invalid. Valid values are 1 and
2.
1000903 Unable to create an hpat with the specified parametric position values of %G% and
%G%.
38000118 An attempt to approximate a general surface with a single Parametric BiCubic
failed.
38000121 Invalid format conversion flag specified for surface conversion.
38000452 Unable to calculate a point on the solid.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_solid_4surface (p. 467) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 599
Construct Actions
Description:
This function creates parametric tricubic or wedge shaped solids which pass through a specified set of
surfaces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
solid IDs.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the solid should be
automatically aligned.
INTEGER param_method This value specifies the parameterization method to
use: 1 = chord Length parameterization, and 2 =
uniform parameterization.
STRING surface_list[] This value specifies the list of surfaces.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each set of four input surfaces. Each solid will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
1000507 Specified Parameterization Method value of %I% is invalid. Valid values are 1 and
2.
38000119 An attempt to approximate a general solid with a single Parametric TriCubic
failed.
38000122 Invalid format conversion flag specified for solid conversion.
38000452 Unable to calculate a point on the solid.
38000493 The Surface interpolating Solid builder failed to create the evaluator table. Solid
was not created.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see asm_const_solid_nsurface (p. 469) in the PCL Reference Manual Examples.
Description:
This function creates parametric bicubic surfaces from two sets of curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING curve1_list[] This value specifies the first set of ruling curves.
STRING curve2_list[] This value specifies the second set of ruling curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
Chapter 3: Geometry Functions 601
Construct Actions
One surface will be created for each pair of input curves. Each surface will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_surface_2curve (p. 470) in the PCL Reference Manual Examples.
602 PCL Reference Manual
Construct Actions
Description:
This function creates parametric bicubic surfaces from three sets of curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
INTEGER param_method This value specifies the surface parameterization
method: 1 = chord length parameterization, and 2
= uniform parameterization.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING curve3_list[] This value specifies the third set of curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each triplet of input curves. Each surface will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_surface_3curve (p. 471) in the PCL Reference Manual Examples.
Description:
This function creates parametric bicubic surfaces from four sets of curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value is set
to an empty string or to #, the function will automatically
allocate and assign a sequential list of surface IDs.
INTEGER param_method This value specifies the surface parameterization method:
1 = chord length parameterization, and 2 = uniform
parameterization.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING curve3_list[] This value specifies the third set of curves.
STRING curve4_list[] This value specifies the fourth set of curves.
Output:
STRING created_ids[VIRTUAL This value returns the created ID list.
]
604 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of four input curves. Each surface will be displayed in the
graphics window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_surface_4curve (p. 473) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 605
Construct Actions
Description:
This function creates parametric bicubic surfaces from a specified set of curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
INTEGER param_method This value specifies the surface parameterization
method: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING curve_list[] This value specifies the list of curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created from the input curves. The surface will be displayed in the graphics window
as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_surface_ncurve (p. 474) in the PCL Reference Manual Examples.
Description:
This function creates parametric bicubic surfaces from three sets of curves defining the boundaries
of the surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING curve3_list[] This value specifies the third set of curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
Chapter 3: Geometry Functions 607
Construct Actions
One surface will be created for each set of three input curves. Each surface will be displayed in the
graphics window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_surface_3edge (p. 476) in the PCL Reference Manual Examples.
608 PCL Reference Manual
Construct Actions
Description:
This function creates parametric bicubic surfaces from four sets of curves defining the boundaries of
the surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING curve3_list[] This value specifies the third set of curves.
STRING curve4_list[] This value specifies the fourth set of curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of four input curves. Each surface will be displayed in the
graphics window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_surface_4edge (p. 477) in the PCL Reference Manual Examples.
610 PCL Reference Manual
Construct Actions
Description:
This function creates parametric bicubic surfaces by extracting surfaces from solids at specified
parametric positions and in specified parametric directions.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING solid_list[] This value specifies the list of solids from which to
extract surfaces.
INTEGER param_plane This value specifies the constant parametric plane in
which to create the surface: 1 = constant U plane, 2
= constant V plane, and 3 = constant W plane.
REAL param_pos This value specifies the parametric position in the
given parametric plane from which to extract the
surfaces.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for the parametric plane specified in each solid. Each surface created will be
displayed in the graphics window.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_surface_extract (p. 478) in the PCL Reference Manual Examples.
Description:
This function creates parametric bicubic surfaces by extracting surfaces from the faces of solids.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING face_list[] This value specifies the list of solid faces from which to
extract surfaces.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
612 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each specified face. Each surface created will be displayed in the graphics
window.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_surface_extract_face (p. 480) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 613
Construct Actions
Description:
This function creates parametric bicubic surfaces by moving curves through space along a defined axis
with the option of simultaneously scaling and rotating the extruded surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING delta[] This value specifies a translation vector defining the
direction and magnitude of the extrusion operation.
REAL scale This value specifies the scaling factor.
REAL angle This value specifies the angle to rotate the curve
around the translation vector during extrusion.
STRING origin[] This value specifies the point of origin of the
extrusion.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_surfaces This value specifies the number of surfaces to create
for each curve.
STRING curve_list[] This value specifies the list of curves to be extruded.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
1000064 Overwrite of existing entity not permitted.
1000211 The length of the Axis equals zero.
38000003 No blob provided.
38000117 An attempt to approximate a general curve with a single Parametric Cubic failed.
38000450 Unable to calculate a point on the curve.
38000451 Unable to calculate a point on the surface.
614 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
The number of surfaces defined by the input value num_surfaces will be created for each input curve.
Each surface will be displayed in the graphics window.
Example:
Please see asm_const_surface_extrude (p. 481) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 615
Construct Actions
Description:
This function creates parametric bicubic surfaces by moving base curves along a path defined by a set
of director curves translated to the origin of the base curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
REAL scale This value specifies the scaling factor.
INTEGER glide_option This value specifies the glide option to use: 0 =
normal project glide option, and 1 = fixed logic
option.
STRING director_curve[] This value specifies the list of curves along which
the base curve will be swept.
STRING base_curve[] This value specifies the list of curves that will be
swept along the director curves to form the surfaces.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000225 Unable to do glide option.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
38000117 An attempt to approximate a general curve with a single Parametric Cubic failed.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of base_curves and director_curves. If there are m base_curves
and n director_curves, m*n surfaces will be created. Each surface will be displayed in the graphics
window.
616 PCL Reference Manual
Construct Actions
Example:
Please see asm_const_surface_glide (p. 482) in the PCL Reference Manual Examples.
Description:
This function creates parametric bicubic surfaces defined by a set of base curves and an offset from
those curves in the direction of the curvature. The offset may be constant or a linear taper.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING thickness1[] This value specifies the constant thickness or the first
thickness at u=0; v=0.
STRING thickness2[] This value is set to NULL if the input value thickness1
is set to constant thickness, otherwise it is the second
thickness at u=0; v=1.
STRING origin[] This value specifies the point to be used as origin of the
normal vector.
INTEGER num_surfaces This value specifies the number of surfaces to be
created from each curve.
LOGICAL normal_rev_direction This value is set to TRUE if the normal is to be flipped
or reversed.
STRING curve_list[] This value specifies the list of curves to be swept using
the normal option.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000211 The length of the Axis equals zero.
16000301 Blank string encountered.
16000302 %A% does not contain enough arguments, looking for %I% arguments.
Chapter 3: Geometry Functions 617
Construct Actions
16000303 %A% has too many arguments, looking for %I% arguments.
16000305 %A% is not a real.
38000117 An attempt to approximate a general curve with a single Parametric Cubic failed.
Remarks:
The number of surfaces defined by the input value num_surfaces will be created for each curve. Each
surface will be displayed in the graphics window.
Example:
Please see asm_const_surface_normal (p. 484) in the PCL Reference Manual Examples.
Description:
This function creates parametric bicubic surfaces by revolving curves about an axis of rotation.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to revolve each
curve.
REAL offset This value specifies the initial offset angle in degrees.
STRING coord_frame[] This value specifies the reference coordinate frame.
STRING curve_list[] This value specifies the list of curves to be revolved.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
1000064 Overwrite of existing entity not permitted.
1000210 Angle of rotation for a parametric entity is greater than 180 degrees.
618 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each curve. Each surface will be displayed in the graphics window.
Example:
Please see asm_const_surface_revolve (p. 485) in the PCL Reference Manual Examples.
Description:
This function creates parametric bicubic surfaces which are the quadrilaterals formed by four sets of
vertex points.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING point1_list[] This value specifies the first set of points defining
vertex 1 of each surface.
STRING point2_list[] This value specifies the second set of points
defining vertex 2 of each surface.
STRING point3_list[] This value specifies the third set of points defining
vertex 3 of each surface.
STRING point4_list[] This value specifies the fourth set of points
defining vertex 4 of each surface.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Chapter 3: Geometry Functions 619
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of four input vertex points. Each surface will be displayed in the
graphics window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see asm_const_surface_vertex (p. 487) in the PCL Reference Manual Examples
620 PCL Reference Manual
Construct Actions
Description:
This function will perform boolean operations on the target solid with the list of tool solids. The tool
solids will be deleted after the operation.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
INTEGER boolean_type This value specifies the boolean operation type (1
- add, 2 - subtract, 3 - intersect).
STRING target_solids[] This value specifies a single solid to participate the
boolean operation as the target body.
STRING tool_solids[VIRTUAL] This value specifies a list of tool solids for the
boolean operation. They will be deleted
automatically after the operation.
Output:
STRING created_labels[VIRTUAL] This value returns a description of the created solid
identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the solid identifiers that are stored in the database and displayed in a viewport.
Example:
Chapter 3: Geometry Functions 621
Construct Actions
Description:
This function will create a solid block by providing a base origin,x length, y length, z, length, and a
reference coordinate frame. It also provides an option to perform boolean operation with the input
target solid using the created block as the tool solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING x_length[] This value specifies the length of the block along
the x-axis of the reference coordinate frame.
STRING y_length[] This value specifies the length of the block along
the y-axis of the reference coordinate frame
STRING z_length[] This value specifies the length of the block along
the z-axis of the reference coordinate frame
INTEGER boolean_type This value specifies the boolean operation type (0
- no boolean operation, 1 - add, 2 - subtract, 3 -
intersect).
STRING target_solid[] This value specifies a single solid to participate the
boolean operation as the target body if
boolean_type is not 0.
STRING ref_coord[] The value specifies a reference coordinate frame to
orient the block. The default is Coord. 0.
STRING base_origin[] The value specifies the base origin of the block.
Output:
STRING created_labels[VIRTUAL] This value returns a description of the created solid
identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
622 PCL Reference Manual
Construct Actions
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the solid identifiers that are stored in the database and displayed in a viewport.
Example:
None.
Description:
This function will create a solid cone by providing a height, base radius, top radius, base center, axis,
an optional thickness, and an optional reference coordinate frame. It also provides an option to
perform boolean operation with the input target solid using the created cone as the tool solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING height[] This value specifies the height of the cone along its
axis.
STRING base_radius[] This value specifies the base radius of the cone.
STRING top_radius[] This value specifies the top radius of the cone.
STRING thickness[] This value specifies the thickness to created a
hollow cone. The default value is 0.0 (meaning no
hollowing).
INTEGER boolean_type This value specifies the boolean operation type (0
- no boolean operation, 1 - add, 2 - subtract, 3 -
intersect).
STRING target_solid[] This value specifies a single solid to participate the
boolean operation as the target body if
boolean_type is not 0.
STRING ref_coord[] This value specifies an optional reference
coordinate frame to orient the cone. The default is
Coord. 0.
STRING base_center[] This value specifies the base center of the cone.
STRING axis[] This value specifies the axis of the cone.
Output:
Chapter 3: Geometry Functions 623
Construct Actions
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the solid identifiers that are stored in the database and displayed in a viewport.
Description:
This function will create a solid cylinder by providing a height, radius, base center, axis, an optional
thickness, and an optional reference coordinate frame. It also provides an option to perform boolean
operation with the input target solid using the created cylinder as the tool solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING height[] This value specifies the height of the cylinder
along its axis.
STRING radius[] This value specifies the radius of the cylinder.
STRING thickness[] This value specifies the thickness to created a
hollow cylinder. The default value is 0.0 (meaning
no hollowing).
INTEGER boolean_type This value specifies the boolean operation type (0
- no boolean operation, 1 - add, 2 - subtract, 3 -
intersect).
STRING target_solid[] This value specifies a single solid to participate the
boolean operation as the target body if
boolean_type is not 0.
624 PCL Reference Manual
Construct Actions
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the solid identifiers that are stored in the database and displayed in a viewport.
Example:
None.
Description:
This function will create a solid sphere by providing a radius, center point, axis, and an optional
reference coordinate frame. It also provides an option to perform boolean operation with the input
target solid using the created sphere as the tool solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING radius[] This value specifies the radius of the sphere.
INTEGER boolean_type This value specifies the boolean operation type (0
- no boolean operation, 1 - add, 2 - subtract, 3 -
intersect).
Chapter 3: Geometry Functions 625
Construct Actions
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the solid identifiers that are stored in the database and displayed in a viewport.
Example:
None.
626 PCL Reference Manual
Construct Actions
Description:
This function creates solids by moving a surface through space along a defined axis while
simultaneously scaling and rotating the created solids. Use this function to create Parasolid solids.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING delta[] This value specifies a translation vector defining
the direction and magnitude of the extrusion
operation.
REAL scale This value specifies the scaling factor.
REAL angle This value specifies the angle to rotate the surface
around the translation vector during extrusion.
STRING origin[] This value specifies the point of origin of the
extrusion.
STRING coord_frame[] This value specifies the reference coordinate
frame.
STRING surface_list[] This value specifies the list of surfaces to be
extruded.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
Chapter 3: Geometry Functions 627
Construct Actions
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each input surface. Each solid will be displayed in the graphics window.
Example:
None.
628 PCL Reference Manual
Construct Actions
Description:
This function creates a solid of revolution by revolving a set of surfaces about an axis of rotation. Use
this function to create Parasolid solids.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to revolve each
surface in degrees.
REAL offset This value specifies the initial offset angle in
degrees.
STRING coord_frame[] This value specifies the reference coordinate
frame.
STRING surface_list[] This value specifies the list of surfaces to be
revolved.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
Chapter 3: Geometry Functions 629
Construct Actions
Remarks:
This function displays a message listing the number of solids created and their IDs.
Each solid will be displayed in the graphics window.
Example:
Description:
This function will create a solid torus by providing a major radius, minor radius, center, axis, and an
optional reference coordinate frame. It also provides an option to perform boolean operation with the
input target solid using the created torus as the tool solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING major_radius[] This value specifies the major radius of the torus.
STRING minor-radius[] This value specifies the minor radius of the torus.
STRING thickness[] This value specifies the thickness to created a
hollow torus. The default value is 0.0 (meaning no
hollowing).
630 PCL Reference Manual
Construct Actions
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the solid identifiers that are stored in the database and displayed in a viewport.
Example:
None.
Chapter 3: Geometry Functions 631
Construct Actions
Description:
This function will create a midsurface from a solid or a pair of surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
INTEGER midsurf_option This value specifies the edit option used to edit the
midsurface. Valid values are 1 thru 3, where:
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the surface identifiers that are stored in the database and displayed in a
viewport.
Description:
This function creates circular arcs in two dimensional space, defined by starting points, midpoints,
and end points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
LOGICAL create_center This value is set to TRUE if a point is to be created
at the center of the arc.
STRING plane_list[] This value specifies the construction plane of the
arc.
STRING start_list[] This value specifies the start point of the arc.
STRING mid_list[] This value specifies the midpoint of the arc.
STRING end_list[] This value specifies the end point of the arc.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Chapter 3: Geometry Functions 633
Construct Actions
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each set of three points. Each curve will be displayed in the graphics
window.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_arc3point_v1 (p. 488) in the PCL Reference Manual Examples.
634 PCL Reference Manual
Construct Actions
Description:
This function creates circular arcs in two dimensional space, defined by starting points, midpoints,
and end points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
LOGICAL create_center This value is set to TRUE if a point is to be created
at the center of the arc.
STRING plane_list[] This value specifies the construction plane of the
arc.
STRING start_list[] This value specifies the start point of the arc.
STRING mid_list[] This value specifies the midpoint of the arc.
STRING end_list[] This value specifies the end point of the arc.
LOGICAL project_points This value specifies, when set to TRUE, that the
starting points are to be projected onto the plane.
When this value is set to FALSE the construction
plane will be translated to the starting point
location but will still be parallel to the original
plane.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each set of three points. Each curve will be displayed in the graphics
window.
Chapter 3: Geometry Functions 635
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_arc3point_v2 (p. 489) in the PCL Reference Manual Examples.
Description:
This function creates circular arcs defined by start points, midpoints, and end points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
LOGICAL create_center This value is set to TRUE if a point is to be created
at the center of the arc.
STRING start_list[] This value specifies the start point of an arc.
STRING mid_list[] This value specifies the midpoint of an arc.
STRING end_list[] This value specifies the end point of an arc.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
636 PCL Reference Manual
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each set of three points. Each curve will be displayed in the graphics
window.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_arc3point (p. 490) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 637
Construct Actions
Description:
This function creates B-spline curves from sets of points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING point_list[] This value specifies the point list.
INTEGER order This value specifies the order of the B-spline
curves.
LOGICAL interpolate This value is set to TRUE if the curve is to be
interpolated, or to FALSE if the curve is to be
approximated.
INTEGER param_method This value specifies the parameterization method:
1 = chordal arc length, 2 = modified chordal arc
length, and 3 = uniform.
LOGICAL closed This value is set to TRUE if the curve is to be a
closed curve.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each point list. Each curve will be displayed in the graphics window as it
is created.
638 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
38000472 The number of points selected must be greater or equal to the order of the B-spline
curve.
38000475 The maximum number of points used to construct a nurbs curve is currently
limited to 1000.
Example:
Please see sgm_const_curve_bspline (p. 491) in the PCL Reference Manual Examples.
Description:
This function constructs curves on surfaces by extraction from a set of surfaces at a set of positions
in a specified parametric direction.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING surface_list[] This value specifies the surface list from which the
curves will be extracted.
INTEGER direction This value specifies the parametric direction to
create the curve in: 1 = C1 direction, and 2 = C2
direction.
REAL param_pos This value specifies the parametric position in the
given direction from which to extract the curve.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Chapter 3: Geometry Functions 639
Construct Actions
One curve on surface will be created for each surface in the direction and position specified. Each curve
will be displayed in the graphics window as it is created.
This function can display an information popup message form with the following message:
This function can display a warning popup message form with the following message:
38000433 A Zero length curve would have been created had the process continued. Modify
application input and try again.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000518 Specified Parametric Direction value of %I% is invalid. Valid values are 1 and 2.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_curve_extract (p. 492) in the PCL Reference Manual Examples.
640 PCL Reference Manual
Construct Actions
Description:
This function creates curves by extraction from edges of surfaces or solids.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING edge_list[] This value specifies the list of edges from which
the curves are extracted.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each edge input. Each curve will be displayed in the graphics window.
This function can display an information popup message form with the following message:
This function can display a warning popup message form with the following message:
1000054 An invalid geometric entity type was used as input. The valid entity type to use
is %A%. Unable to process request.
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_extract_edge (p. 493) in the PCL Reference Manual Examples.
Description:
This function constructs a fillet of a specified radius between any two co-planar curves.
Input:
STRING output_ids[] This value specifies the line ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of line IDs.
REAL radius This value specifies the fillet radius.
LOGICAL trim_original This value is set to TRUE if the original line is to
be trimmed after the fillet is created.
STRING point1_list[] This value specifies the first fillet location list.
STRING point2_list[] This value specifies the second fillet location list.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Curves will be created for each set of lines and points. All curves created will be displayed in the graphics
window. The created curves will be circular arcs. The input curves must be co-planar.
642 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
1000500 There must be at least one line as input. The invalid value input was %I%.
1000557 The fillet radius value is unacceptable. The radius value of %G% must be greater
than the fillet tolerance value of %G%.
1000558 The fillet line with radius %G% cannot be created between the two input curves.
1000571 The fillet curve has a zero angle of rotation. The fillet cannot be created.
1000572 The fillet curve has a zero radius. The fillet cannot be created.
2001070 Unable to acquire %I% words of virtual memory.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
Example:
None.
Description:
This function creates a true involute curve defined as the unwinding of an imaginary string from a
circular bobbin.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING axis[] This value specifies the axis of the involute curve.
INTEGER option This value specifies the option to use in creating
the involute. If option = 1 the radii method is used,
otherwise the angle method is used.
Chapter 3: Geometry Functions 643
Construct Actions
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves defined by the input value num_curves will be created for each point. Each curve
will be displayed in the graphics window.
Example:
None.
644 PCL Reference Manual
Construct Actions
Description:
This function creates true involute curves from sets of points with end point slope control.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
LOGICAL slope_control This value is set to TRUE if the end point slope
control is to be enforced.
STRING point_list[] This value specifies the point list.
STRING slope_list1[] This value specifies the vectors defining the initial
slope.
STRING slope_list2[] This value specifies the vectors defining the final
slope.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
None.
Example:
Please see sgm_const_curve_loft (p. 494) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 645
Construct Actions
Description:
This function will create constant or variable offset curves from other curves. It should be noted that
while nonplanar curves could be specified, the offset will occur in the least-squares plane of the input
curve. If the input curve is a straight line, then a direction vector is required.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER od_flag This value specifies the offset distance flag;
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the solid identifiers that are stored in the database and displayed in a viewport.
Example:
None
Description:
This function constructs curves on a set of surfaces by projecting an existing set of curves along a
projection vector onto a set of surfaces.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING curve_list[] This value specifies the list of curves to project
onto the list of surfaces.
STRING surface_list[] This value specifies the list of surfaces onto which
the curves are to be projected.
INTEGER etype This value specifies the entity type to project the
curve to:
LOGICAL delete_original This value is set to TRUE if the original curves are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
INTEGER project_method This value specifies the method of defining the
projection vector: 1 = the curves to be projected lie
in a plane and it is desired to project the curves
normal to this plane, 2 = the direction of projection
is normal to the surface at the point of closest
approach to the curve, 3 = the direction of
projection is to be given by a vector, and 4 = the
direction of projection is the view vector.
STRING vector[] This value specifies the projection vector.
STRING coord_frame[] This value specifies the coordinate frame for the
projection vector.
REAL projection_tolerance This value specifies a tolerance parameter. The
algorithm creates all curves along the projected
surface so that the maximum distance lies between
them is the distance defined by this value
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This function can display an information popup message form with the following messages:
1000040 Duplicate %A% was not created at users request
38000412 Negating the View Vector coordinates and trying again...
This function can display a warning popup message form with the following message:
38000415 Skipping zero length Curve %I%.
This function can display a fatal popup message form with the following messages:
1000540 The projection vector has zero length.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve
38000488 Unable to manifold the curve(s) to the surface.
38000845 Unable to acquire %I% words of virtual memory.
Example:
None.
648 PCL Reference Manual
Construct Actions
Description:
This function creates arcs by revolving points about an axis of rotation.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to revolve each
point.
REAL offset This value specifies the initial offset angle.
STRING coord_frame[] This value specifies the reference coordinate
frame.
STRING point[] This value specifies the list of points to be
revolved.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each point. Each curve will be displayed in the graphics window.
Example:
Please see sgm_const_curve_revolve (p. 495) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 649
Construct Actions
Description:
This function creates bi-parametric surfaces from three sets of curves defining the boundary of the
surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING curve3_list[] This value specifies the third set of curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of three input curves. Each surface will be displayed in the
graphics window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
38000403 Bounding Curves must form a closed loop. Surface was not created.
38000450 Unable to calculate a point on the curve.
38000451 Unable to calculate a point on the surface.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_surface_3edge (p. 496) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 651
Construct Actions
Description:
This function creates manifold surfaces from three sets of curves defining the boundary of the
parametric or generalized coons surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING curve3_list[] This value specifies the third set of curves.
STRING surface_list[] This value specifies the surfaces on which the
manifold surfaces are created.
LOGICAL cubic This value specifies, when set to TRUE, that
parametric bicubic surfaces be created. When this
value is set to FALSE, generalized coons surfaces
will be created.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of three input curves. Each surface will be displayed in the
graphics window as it is created.
652 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_surface_3edge_man (p. 498) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 653
Construct Actions
Description:
This function creates bi-parametric surfaces from four sets of curves defining the boundary of the
surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING curve3_list[] This value specifies the third set of curves.
STRING curve4_list[] This value specifies the fourth set of curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of four input curves. Each surface will be displayed in the
graphics window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
38000402 The Surface Edge Surface builder failed to create the evaluator table. Surface was
not created.
38000403 Bounding Curves must form a closed loop. Surface was not created.
38000450 Unable to calculate a point on the curve.
38000451 Unable to calculate a point on the surface.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_surface_4edge (p. 499) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 655
Construct Actions
Description:
This function creates manifold surfaces from four sets of curves defining the boundary of the
parametric or generalized coons surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING curve3_list[] This value specifies the third set of curves.
STRING curve4_list[] This value specifies the fourth set of curves.
STRING surface_list[] This value specifies the surfaces on which the
manifold surfaces are created.
LOGICAL cubic This value specifies, when set to TRUE, that
parametric bicubic surfaces be created. When this
value is set to FALSE, generalized coons surfaces
will be created.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of four input curves. Each surface will be displayed in the
graphics window as it is created.
656 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_surface_4edge_man (p. 501) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 657
Construct Actions
Description:
This function creates surfaces by extraction from the faces of solids.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING face_list[] This value specifies the list of solid faces from
which the surfaces are extracted.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each parametric plane specified in each solid. Each surface created will
be displayed in the graphics window.
This function can display a fatal popup message form with the following message:
Example:
Please see sgm_const_surface_extract_face (p. 502) in the PCL Reference Manual Examples.
658 PCL Reference Manual
Construct Actions
Description:
This function creates bi-parametric surfaces by moving curves through space along a defined axis
while simultaneously scaling and rotating the created surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING delta[] This value specifies a translation vector defining
the direction and magnitude of the extrusion
operation.
REAL scale This value specifies the scaling factor.
REAL angle This value specifies the angle to rotate the curve
around the translation vector during extrusion.
STRING origin[] This value specifies the point of origin of the
extrusion.
STRING coord_frame[] This value specifies the reference coordinate
frame.
STRING curve_list[] This value specifies the list of curves to be
extruded.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
38000003 No blob provided.
38000430 The Sweep Extrude Surface builder failed to create the evaluator table. Surface was
not created.
38000450 Unable to calculate a point on the curve.
38000451 Unable to calculate a point on the surface.
38000845 Unable to acquire %I% words of virtual memory.
Chapter 3: Geometry Functions 659
Construct Actions
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each input curve. Each surface will be displayed in the graphics window.
Example:
Please see sgm_const_surface_extrude (p. 504) in the PCL Reference Manual Examples.
Description:
This function constructs a surface by "gliding" a base curve along a director curve.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
REAL scale This value specifies the scale factor to apply to the
glide.
INTEGER glide_option This value specifies the glide option:
This function can display a fatal popup message form with the following messages:
38000431 The Sweep Glide Surface builder failed to create the evaluator table. Surface was
not created.
38000845 Unable to acquire %I% words of virtual memory.
Chapter 3: Geometry Functions 661
Construct Actions
Description:
This function constructs a surface by "gliding" a base curve along a director curve.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
LOGICAL scale If .TRUE., the local scaling is determined by the
chordal distance between the two director curves.
If .FALSE., the base curve remains unscaled.
STRING director1_curve_list[] This value specifies the list of primary curves
along which the base curve is to glide.
STRING director2_curve_list[] This value specifies the list of secondary curves
which, along with the primary curves control the
orientation and possibly the scaling of the base
curve.
STRING base_curve_list[] This value specifies the list of base curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This function can display an information popup message form with the following messages:
1000040 Duplicate %A% was not created at users request
This function can display a fatal popup message form with the following messages:
38000431 The Sweep Glide Surface builder failed to create the evaluator table. Surface was
not created.
38000845 Unable to acquire %I% words of virtual memory.
Description:
This function will create constant offset surfaces from other surfaces .
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
REAL dist This value specifies the distance by which the
surface is normally offset.
INTEGER ncopies This value specifies the number of copies of the
offset surface to make.
LOGICAL guide_surface This value specifies whether the first surface in the
surface list is to be used as a guide surface to define
the offset direction for all surfaces in the list.
STRING surface_list[] This value specifies the input surface list to create
the offset surface(s) from.
Output:
STRING created_labels[VIRTUAL] This value returns a description of the created
surface identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the solid identifiers that are stored in the database and displayed in a viewport.
Example:
None.
Chapter 3: Geometry Functions 663
Construct Actions
Description:
This function creates surfaces by revolving curves about an axis of rotation.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to revolve each
curve in degrees.
REAL offset This value specifies the initial offset angle in
degrees.
STRING coord_frame[] This value specifies the reference coordinate
frame.
STRING curve_list[] This value specifies the list of curves to be
revolved.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
1000211 The length of the Axis equals zero.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
38000451 Unable to calculate a point on the surface.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
Surfaces will be created for each curve. All surfaces created will be displayed in the graphics window.
664 PCL Reference Manual
Construct Actions
Example:
Please see sgm_const_surface_revolve (p. 505) in the PCL Reference Manual Examples.
Description:
This function creates vectors between two sets of points.
Input:
STRING output_ids[] This value specifies the vector ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of vector IDs.
STRING base_point_list[] This value specifies the vector base point list.
STRING tip_point_list[] This value specifies the vector tip point list.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of vectors created and their IDs.
One vector will be created for each point set. Each vector will be displayed in the graphics window as it
is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
38000441 A Zero length vector would have been created had the process continued. Modify
application input and try again.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_vector_2point (p. 506) in the PCL Reference Manual Examples.
Description:
This function creates a vector between two points with an option to create a unit vector.
Input:
STRING output_ids[] This value specifies the vector ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of vector IDs.
STRING point1_list[] This value specifies the first point list.
STRING point2_list[] This value specifies the second point list.
LOGICAL unit_vector This value specifies whether the vector to be
created is a unit vector.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of vectors created and their IDs.
One vector will be created for each set of points. Each vector will be displayed in the graphics window.
666 PCL Reference Manual
Construct Actions
This function can display a warning popup message form with the following message:
38000441 A zero length vector would have been created had the process continued Modify
application input and try again.
This function can display a fatal popup message form with the following message:
Example:
None.
Description:
This function constructs vectors by interpolating along a curve.
Input:
STRING output_ids[] This value specifies the vector ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of vector IDs.
STRING curve_list[] This value specifies the list of curves to interpolate
along.
REAL ratio This value specifies the vector spacing ratio (the
distance defined by (nvectors to endpoint) divided
by the distance defined by (startpoint to second
point).
INTEGER vector_count This value specifies the number of interior vectors
to create.
INTEGER param_method This value specifies the parameterization method
of interpolation:
Description:
This function creates vectors at the intersections of two sets of planes.
Input:
STRING output_ids[] This value specifies the vector ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of vector IDs.
STRING first_plane_list[] This value specifies the first list of planes to
intersect with the second.
STRING second_plane_list[] This value specifies the second list of planes to
intersect with the first.
LOGICAL vector_rev_direction This value specifies, when set to TRUE, that the
vector direction be reversed.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
668 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of vectors created and their IDs.
One vector will be created for each pair of planes. Each vector will be displayed as it is created.
A base and tip of a vector is determined by projecting two plane origins onto an intersection curve, the
first origin being the base and the second being the tip. If a base and tip are not unique, then the tip is
assumed and the input value vector_rev_direction will be used to control the vector direction, which will
be arbitrary.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_vector_intersect (p. 507) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 669
Construct Actions
Description:
This function creates vectors from base points, directions, and magnitudes.
Input:
STRING output_ids[] This value specifies the vector ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of vector IDs.
STRING magnitude_list[] This value specifies the vector magnitude list.
STRING direction_list[] This value specifies the vector direction list.
STRING base_point_list[] This value specifies the vector base point list.
STRING coord_frame[] This value specifies the coordinate frame in which
the vector will be created.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of vectors created and their IDs.
One vector will be created for each point. Each vector will be displayed in the graphics window as it is
created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
38000441 A Zero length vector would have been created had the process continued. Modify
application input and try again.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_vector_magnitude (p. 509) in the PCL Reference Manual Examples.
Description:
This function creates vectors that are normal to planes, surfaces, or element faces.
Input:
STRING output_ids[] This value specifies the vector ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of vector IDs.
INTEGER normal_option This value specifies the normal option: 1 = normal
to a plane, 2 = normal to a surface, and 3 = normal
to an element face.
STRING entity_list[] This value specifies the planes, surfaces, and/or
element faces used to calculate the normal vectors.
STRING magnitude_list[] This value specifies the vector magnitude list.
STRING base_point_list[] This value specifies the vector base point list.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of vectors created and their IDs.
Chapter 3: Geometry Functions 671
Construct Actions
One vector will be created for each entity in the entity list. Each vector will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
38000441 A Zero length vector would have been created had the process continued. Modify
application input and try again.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_vector_normal (p. 510) in the PCL Reference Manual Examples.
Description:
This function creates product vectors from two sets of vectors. The generated vectors are based on
the origin points of the first set of vectors.
Input:
STRING output_ids[] This value specifies the vector ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of vector IDs.
STRING vector_list1[] This value specifies the first vector list.
STRING vector_list2[] This value specifies the second vector list.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
672 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of vector created and their IDs.
One vector will be created for each entity in the entity list. Each vector will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
38000441 A Zero length vector would have been created had the process continued. Modify
application input and try again.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_vector_product (p. 511) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 673
Construct Actions
Description:
This function creates bi-parametric surfaces bounded by the quadrilaterals formed by four sets of
vertex points.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING point1_list[] This value specifies the first set of points defining
vertex 1 of each surface.
STRING point2_list[] This value specifies the second set of points
defining vertex 2 of each surface
STRING point3_list[] This value specifies the third set of points defining
vertex 3 of each surface.
STRING point4_list[] This value specifies the fourth set of points
defining vertex 4 of each surface.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of four input vertex points. Each surface will be displayed in the
graphics window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_surface_vertex (p. 513) in the PCL Reference Manual Examples.
Description:
This function constructs curves from a set of picklist construct methods.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING construct_method[] This value specifies the set of construct methods
made up of the resulting strings produced by the
last 3 picklist items of the Geometry
Create/Surface/Curve form.
Output:
INTEGER exist This value is set to 1 if the curve already exists.
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
Chapter 3: Geometry Functions 675
Construct Actions
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each construct list. Each curve will be displayed in the graphics window as
it is created.
Example:
Please see sgm_create_curve_boundary (p. 514) in the PCL Reference Manual Examples.
676 PCL Reference Manual
Construct Actions
Description:
This function constructs B-spline curves from sets of points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING point_list[] This value specifies the point list.
INTEGER order This value specifies the order of the B-spline
curves.
LOGICAL interpolate This value is set to TRUE if the curve is to be
interpolated, or to FALSE if the curve is to be
approximated.
INTEGER param_method This value specifies the parameterization method,
1 = chordal arc length, 2 = modified chordal arc
length, and 3 = uniform.
LOGICAL closed This value is set to TRUE if the curve is to be
closed.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each point list. Each curve will be displayed in the graphics window as it
is created.
Chapter 3: Geometry Functions 677
Construct Actions
This function can display a fatal popup message form with the following message:
38000472 The number of points selected must be greater or equal to the order of the
B-spline curve.
Example:
Please see sgm_create_curve_bspline (p. 515) in the PCL Reference Manual Examples.
Description:
This function constructs chains or composite curves from a list of curves.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING curve_list[] This value specifies the curve list.
LOGICAL delete_original This value is set to TRUE if the original curves are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One chain will be created for each curve list. Each chain will be displayed in the graphics window as it
is created.
678 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_create_curve_chain (p. 517) in the PCL Reference Manual Examples.
Description:
This function creates chains or composite curves from a list of curves.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs sequentially. This value is used only
if the original curve to extend is a topological edge.
STRING curve_list[] This value specifies the original curves to chain.
LOGICAL delete_original This value is set to TRUE if the original curves are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
INTEGER segment_id This value specifies the id for the graphics segment
used for the creation of graphics markers.
Output:
INTEGER segment_id This value returns the id of the graphics segment id
used for the creation of graphics markers.
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Chapter 3: Geometry Functions 679
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One chain curve will be created for each curve list. The chain curve created will be displayed in the
graphics window.
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_create_curve_chain_v1 (p. 518) in the PCL Reference Manual Examples.
680 PCL Reference Manual
Construct Actions
Description:
This function constructs loft-spline curves from sets of points with end point slope control.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
LOGICAL slope_control This value is set to TRUE if the end point slope
control is to be enforced.
STRING point_list[] This value specifies the point list.
STRING slope_list1[] This value specifies the vectors defining the initial
slope.
STRING slope_list2[] This value specifies the vectors defining the final
slope.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each point list. Each curve will be displayed in the graphics window as it
is created.
Example:
Please see sgm_create_curve_loft (p. 520) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 681
Construct Actions
Description:
This function creates composite trimmed surfaces.
Input:
STRING output_labels[] This value specifies the label of the surface to be
created.
STRING surface_list[] This value specifies the surfaces from which the
composite will be created.
INTEGER build_options This value specifies the options for the builder.
REAL clean_tolerance This value specifies the cleanup tolerance for the
creation of surface boundaries.
REAL gap_tolerance This value specifies the gap distance for the
surface builder.
INTEGER curve_start_label This value specifies the starting label for the
boundary curves that will be created.
INTEGER loop_id This value specifies the loop ID identifying the
outer boundary.
STRING add_list[] This value specifies the edge list to be added to the
free boundary edges defined by the input surface
list.
STRING remove_list[] This value specifies the edge list to be removed
from the free boundary edges defined by the input
surface list.
STRING inner_loop_list[] This value specifies the inner loop edge list.
STRING vertex_list[] This value specifies the vertex list.
LOGICAL delete_cons This value specifies, when set to TRUE, that the
surfaces in the input value surface_list be deleted
after the composite trimmed surfaces are created.
682 PCL Reference Manual
Construct Actions
LOGICAL implicit_topology This value specifies, when set to TRUE, that the
edges of the created surfaces are defined by the
chain links. When this value is set to FALSE the
chain link edges will be combined if there is slope
continuity in the 2D segments.
Output:
STRING created_labels[VIRTUAL] This value returns the label of the composite
surface created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000056 Curve list is blank. Input required data.
1000057 Surface list is blank. Input required data.
1000707 No surfaces were found to exist in the database as defined in the surface list. The
surface list input was %A%.
38000462 Size and complexity of the problem exceeds the available memory.
38001001 No outer boundary has been selected!
38001002 Problem 2: At the red square there is no boundary curve to continue and the loop
is not closed. The white square is showing the start location. White edges are
already checked. Red square is showing the current position.
Possible Action: Add a curve connecting the red square to a red boundary curve
using the < Modify Boundary > tool.
38001003 Problem 1: At the red square there are more than one boundary curves to continue.
The white square is showing the start location. White edges are already checked.
Red square is showing the current position.
Possible Action: Remove the appropriate edge using the < Modify Boundary >
tool.
38001004 Problem 3: The red and green vertices are not part of the selected surfaces;
however, the green vertices are within global tolerance and will be projected onto
the surfaces. Incorrect vertex placement may result in geometric incongruency.
Okay to continue?
38001005 No outer Loop has been defined!
Remarks:
None.
Chapter 3: Geometry Functions 683
Construct Actions
Example:
Please see sgm_create_surface_composite (p. 521) in the PCL Reference Manual Examples.
Description:
This function constructs surfaces from four sets of vertices defined from existing surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
LOGICAL object_surface This value is set to TRUE if the object to be created
is a surface, and to FALSE if it is to be a simple
trimmed surface.
STRING manifold_entity[] This value specifies the manifold surface.
STRING point1_list[] This value specifies the first vertex point list.
STRING point2_list[] This value specifies the second vertex point list.
STRING point3_list[] This value specifies the third vertex point list.
STRING point4_list[] This value specifies the fourth vertex point list.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of four input points. Each surface will be displayed in the
graphics window as it is created.
684 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
38000446 Unable to decompose Surface %I%. The Surface to decompose must be of a type
different from Composite Trimmed Surface.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_create_surface_decompose (p. 524) in the PCL Reference Manual Examples.
Description:
This function constructs a tessellated surface given a collection of shell elements.
Input:
INTEGER output_id This value specifies the surface ID to create.
STRING shell_element_list[] This value specifies the list of shell elements to
create the surface from.
STRING vertex_node_list[] This value specifies the list of nodes that represent
vertices.
INTEGER preview_mode If =1 returns the 4 corner nodes.
INTEGER corner_node_ids[4] If preview_mode =1, this array will have the corner
node Ids.
LOGICAL delete_original This value specifies whether or not to delete the
original shell elements after the surface is created.
Output:
STRING deleted_ids[VIRTUAL] This value returns the deleted element ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This function can display a warning popup message form with the following messages:
61002002 There are %I% inner loops in the selected surface mesh.
61002003 Duplicate vertices with node id %I% are found on the vertex list. Only one vertex
with node id %I% will be used.
Chapter 3: Geometry Functions 685
Construct Actions
61002004 The element edge defined by the nodes with ids %I% and %I% is short (length =
%F%). The resulting tessellated surface may have bad parameterization.If the
program fails to create a surface, edit the mesh and try again.
61002005 The triangle defined by the nodes with ids %I%, %I% and %I% is small (area =
%F%). The resulting tessellated surface may have bad parameterization. If the
program fails to create a surface, edit the mesh and try again
This function can display a fatal popup message form with the following messages:
61003002 No shell elements were selected. Select shell elements to create the surface.
61003003 Insufficient memory available. Close other applications and try again.
61003004 The selected mesh is invalid. Three or more elements in the mesh share the edge
with nodes %I% and %I%.
61003005 There are no free element edges in the selected mesh. The mesh should be an open
shell to create a surface.
61003006 The selected elements form 2 or more disconnected shell meshes. Merge the shell
meshes using finite Elements Modify-Mesh-Sew to one and try again or create a
surface for each shell mesh.
61003007 Failed on abort signal from client.
61003008 The selected mesh is invalid. Three or more elements in the mesh share edges.
This is occurring between elements using the following nodes: %A%
61003009 Error found in disassociating edges with trias.
61003010 The hole with node %I% could not be filled.
61003011 Error on editing the mesh on a hole.
61003012 The selected vertex (Node %I%) is not on the boundary. Select boundary nodes for
vertices and try again.
61003013 Duplicate edge with node ids %I% and %I% found on a boundary. Please edit the
mesh and try again.
61003014 The boundary of the mesh intersects at the node %I%. Please edit the mesh and try
again.
61003015 The input mesh is connected in such a way that it corresponds to the topology of a
torus or other surface of higher genus. We are unable to create a surface mapping
for this situation. You should partition the input into simpler sets and create two
or more surfaces in place of the one just attempted.
61003016 The inner loop with node %I% could not be filled. Please check that inner loop and
see if there are some overlapped elements around that loop.
61003017 Error in selecting four default vertices. Please select 4 vertices on the outer loop of
the mesh and try again.
686 PCL Reference Manual
Construct Actions
Description:
This function constructs a tessellated surface given a collection of shell elements.
Input:
INTEGER output_id This value specifies the surface ID to create.
STRING shell_element_list[] This value specifies the list of shell elements to
create the surface from.
INTEGER preview_mode If =1 returns the 4 corner nodes.
STRING vertex_node_list[] This value specifies the list of nodes that represent
vertices.
INTEGER inner_loops_option This value specifies which loops are to be
preserved:
=0; All
=1; None
=0; Fast
61003015 The input mesh is connected in such a way that it corresponds to the topology of a
torus or other surface of higher genus. We are unable to create a surface mapping
for this situation. You should partition the input into simpler sets and create two
or more surfaces in place of the one just attempted.
61003016 The inner loop with node %I% could not be filled. Please check that inner loop and
see if there are some overlapped elements around that loop.
61003017 Error in selecting four default vertices. Please select 4 vertices on the outer loop of
the mesh and try again.
Description:
This function constructs ruled surfaces between two sets of curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING curve1_list[] This value specifies the first set of ruling curves for
the start of each surface.
STRING curve2_list[] This value specifies the second set of ruling curves
for the end of each surface.
INTEGER ruled_form This value specifies the ruled surface
parameterization form: 0 = equal relative arc
length, and 1 = equal relative parametric values.
LOGICAL auto_align This value specifies, when set to TRUE, that the
curves used to construct the surface should be
automatically aligned.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Chapter 3: Geometry Functions 689
Construct Actions
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each pair of input curves. Each surface will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_create_surface_ruled (p. 525) in the PCL Reference Manual Examples.
690 PCL Reference Manual
Construct Actions
Description:
This function constructs a trimmed surfaces from a parent surface and outer and/or inner boundary
trim curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING outer_curve_list[] This value specifies the outer boundary trim
curves.
STRING inner_curve_list[] This value specifies the inner boundary trim
curves.
STRING surface[] This value specifies the parent surface to trim.
LOGICAL outer_curve_delete This value is set to TRUE if the outer boundary
trim curves are to be deleted after trimmed surface
is created.
LOGICAL inner_curve_delete This value is set to TRUE if the inner boundary
trim curves are to be deleted after trimmed surface
is created.
LOGICAL delete_surface This value is set to TRUE if the parent surface is to
be deleted after trimmed surface is created.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of trimmed surfaces created and their IDs.
Chapter 3: Geometry Functions 691
Construct Actions
One trimmed surface will be created from the surface and outer/inner boundary curves. Each trimmed
surface will be displayed in the graphics window as it is created.
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_create_surface_trimmed (p. 527) in the PCL Reference Manual Examples.
692 PCL Reference Manual
Construct Actions
Description:
This function constructs a trimmed surface from a parent surface and/or outer and inner boundary
curves with an option of how to define the edges of the trimmed surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING outer_curve_list[] This value specifies the outer boundary trim
curves.
STRING inner_curve_list[] This value specifies the inner boundary trim
curves.
STRING surface[] This value specifies the parent surface to trim.
LOGICAL outer_curve_delete This value is set to TRUE if the outer boundary
trim curves are to be deleted after trimmed surface
is created.
LOGICAL inner_curve_delete This value is set to TRUE if the inner boundary
trim curves are to be deleted after trimmed surface
is created.
LOGICAL delete_surface This value is set to TRUE if the parent surface is to
be deleted after trimmed surface is created.
LOGICAL implicit_topology This value is set to TRUE if the edges are defined
from the chain links, or to FALSE if the edges are
to be derived from the slope continuity in the 2D
segments.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Chapter 3: Geometry Functions 693
Construct Actions
Remarks:
This function displays a message listing the number of trimmed surfaces created and their IDs.
One trimmed surface will be created from the surface and outer/inner boundary curves. Each trimmed
surface will be displayed in the graphics window as it is created.
This function can display a warning popup message form with the following message:
38000482 This application only works with one surface at a time. Subsequent selected
surfaces will be ignored.
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_create_surface_trimmed_v1 (p. 529) in the PCL Reference Manual Examples.
694 PCL Reference Manual
Construct Actions
Description:
This function constructs circular arcs in a two-dimensional space, defined by a set of construction
planes, center points, starting points, and ending points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER arc_angle This value specifies the arc angle to use: 1 =
minimum arc angle, and 2 = maximum arc angle.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING center_point_list[] This value specifies the list of points defining the
center points of the circular arcs.
STRING start_point_list[] This value specifies the list of points defining the
starting points of the circular arcs.
STRING end_point_list[] This value specifies the list of points defining the
ending points of the circular arcs.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of circular arcs created and their IDs.
One circular arc will be created for each point input set. Each circular arc created will be displayed in the
graphics window.
Chapter 3: Geometry Functions 695
Construct Actions
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_arc2point (p. 532) in the PCL Reference Manual Examples.
Description:
This function creates circular arcs in a two-dimensional space, defined by a set of construction planes,
center points or a radius, starting points, and ending points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER arc_method This value specifies the arc method: 1 = define arc
by center, start and end points, and 2 = define arc
by start point, end point and radius.
REAL radius This value specifies the arc radius if the input value
arc_method is set to 2.
LOGICAL create_center This value is set to TRUE if the arc center point is
to be created along with the arc if the input value
arc_method is set to 2.
696 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of circular arcs created and their IDs.
One circular arc will be created for each point input set. Each circular arc and point created will be
displayed in the graphics window.
One point will be created if the input value create_center is set to TRUE.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
38000418 The Arc radius must be greater than zero. Invalid value input was %G%.
38000424 The center point and start point define a zero radius.
38000440 Invalid 2D Arc2Point method. Must be 1 or 2. Try again.
38000442 The Radius value of %G% is too small for the input start and end points. Radius
magnitude must be at least %G%.
38000450 Unable to calculate a point on the curve.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_curve_2d_arc2point_v1 (p. 533) in the PCL Reference Manual Examples.
698 PCL Reference Manual
Construct Actions
Description:
This function creates circular arcs in a two-dimensional space, defined by a set of construction planes,
center points or a radius, starting points, and ending points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER arc_method This value specifies the arc method: 1 = define arc
by center, start and end points, and 2 = define arc
by start point, end point and radius.
REAL radius This value specifies the arc radius if the input value
arc_method is set to 2.
LOGICAL create_center This value is set to TRUE if the arc center point is
to be created along with the arc and if the input
value arc_method is equal to 2.
LOGICAL center_rev_direction This value is set to TRUE if the arc center is to be
flipped/rotated in the counter-clockwise direction
before the arc is created and of the input value
arc_method is equal to 2.
INTEGER arc_angle This value specifies the arc angle to use: 1 =
minimum arc angle, and 2 = maximum arc angle.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING center_point_list[] This value specifies the list of points defining the
center points of the circular arcs.
STRING start_point_list[] This value specifies the list of points defining the
starting points of the circular arcs.
STRING end_point_list[] This value specifies the list of points defining the
ending points of the circular arcs.
Chapter 3: Geometry Functions 699
Construct Actions
LOGICAL project_points This value specifies, when set to TRUE, that the
center points be projected onto the plane. When
this value is set to FALSE and the input value
arc_method is not set to 2, the construction plane
will be translated to the center point location and
will still be parallel to the original plane. If this
value is set to FALSE and the input value
arc_method is set to 2, the construction plane is
translated to the starting point location and will
still be parallel to the original plane.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of circular arcs created and their IDs.
One circular arc will be created for each point input set. Each circular arc and point created will be
displayed in the graphics window.
One point will be created if input value create_center is set to TRUE.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_arc2point_v2 (p. 534) in the PCL Reference Manual Examples.
Description:
This function creates circular arcs in a two-dimensional space, defined by a set of construction planes,
center points, a radius, a starting angle and an end angle.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
REAL radius This value specifies the arc radius.
REAL start_angle This value specifies the arc start angle in degrees.
REAL end_angle This value specifies the arc end angle in degrees.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING center_point_list[] This value specifies the list of points defining the
center points of the circular arcs.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of circular arcs created and their IDs.
Chapter 3: Geometry Functions 701
Construct Actions
One circular arc will be created for each point input. Each circular arc created will be displayed in the
graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_arcangles (p. 535) in the PCL Reference Manual Examples.
Description:
This function creates circular arcs in a two-dimensional space, defined by a set of construction planes,
center points, a radius, a starting angle and an end angle.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
REAL radius This value specifies the arc radius.
REAL start_angle This value specifies the arc start angle in degrees.
REAL end_angle This value specifies the arc end angle in degrees.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING center_point_list[] This value specifies the list of points defining the
center point of the circular arc.
702 PCL Reference Manual
Construct Actions
LOGICAL project_points This value specifies, when set to TRUE, that the
center points be projected onto the plane. When
this value is set to FALSE, the construction plane
will be translated to the center point location and
will still be parallel to the original plane.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of circular arcs created and their IDs.
One circular arc will be created for each point input. Each circular arc created will be displayed in the
graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_arcangles_v1 (p. 537) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 703
Construct Actions
Description:
This function constructs circular arcs in a two-dimensional space, defined by a set of construction
planes, starting points, midpoints, and ending points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING start_point_list[] This value specifies the list of points defining the
starting points of the circular arcs.
STRING middle_point_list[] This value specifies the list of points defining the
midpoints of the circular arcs.
STRING end_point_list[] This value specifies the list of points defining the
ending points of the circular arcs.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of circular arcs created and their IDs.
One circular arc will be created for each point input set. Each circular arc created will be displayed in the
graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_arc3point (p. 538) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 705
Construct Actions
Description:
This function constructs circles in a two-dimensional space, defined by a set of center points and a
radius or a set of radii.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER radius_method This value specifies the method used to define a
radius: 1 = scalar radius value, and 2 = point
location.
REAL radius This value specifies the radius if the input value
radius_method is equal to 1 and is ignored if the
input value radius_method is set to 2.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING radius_point_list[] This value specifies the list of points defining the
radius of the circle if the input value
radius_method is set to 2 and is ignored if the input
value radius_method is set to 1.
STRING center_point_list[] This value specifies the list of points defining the
center point of the circle.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of circle created and their IDs.
706 PCL Reference Manual
Construct Actions
One circle will be created for each center point and radius input set. Each circle created will be displayed
in the graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_circle (p. 539) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 707
Construct Actions
Description:
This function constructs circles in a two-dimensional space, defined by a set of center points and a
radius or a set of radii.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER radius_method This value specifies the method used to define a
radius: 1 = scalar radius value, and 2 = point
location.
REAL radius This value specifies the radius if the input value
radius_method is equal to 1 and is ignored if the
input value radius_method is set to 2.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING radius_point_list[] This value specifies the list of points defining the
radius of the circle if the input value
radius_method is set to 2 and is ignored if the input
value radius_method is set to 1.
STRING center_point_list[] This value specifies the list of points defining the
center point of the circle.
LOGICAL project_points This value specifies, when set to TRUE, that the
center points be projected onto the plane. When
this value is set to FALSE, the construction plane
will be translated to the center point location and
will still be parallel to the original plane.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
708 PCL Reference Manual
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of circle created and their IDs.
One circle will be created for each center point and radius input set. Each circle created will be displayed
in the graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_circle_v1 (p. 540) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 709
Construct Actions
Description:
This function constructs circles in a two-dimensional space, defined by a set of center points and a
radius or a set of radii.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER radius_method This value specifies the method used to define a
radius: 1 = scalar radius value, and 2 = point
location.
REAL radius This value specifies the radius if the input value
radius_method is equal to 1 and is ignored if the
input value radius_method is set to 2.
STRING plane_list[] This value specifies the list of planes in which to
construct the arcs.
STRING radius_point_list[] This value specifies the list of points defining the
radius of the circle if the input value
radius_method is set to 2 and is ignored if the input
value radius_method is set to 1.
STRING center_point_list[] This value specifies the list of points defining the
center point of the circle.
LOGICAL project_points This value specifies, when set to TRUE, that the
center points be projected onto the plane. When
this value is set to FALSE, the construction plane
will be translated to the center point location and
will still be parallel to the original plane.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
710 PCL Reference Manual
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of circle created and their IDs.
One circle will be created for each center point and radius input set. Each circle created will be displayed
in the graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_circle_v1 (p. 540) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 711
Construct Actions
Description:
This function constructs curves perpendicular to an existing set of curves and passing through a set
of points on the existing curves in a set of construction planes.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
REAL length This value specifies the length of the created
curves.
LOGICAL curve_rev_direction This value is set to TRUE if the curve direction is
to be flipped relative to the length.
STRING plane_list[] This value specifies the list of planes in which the
curves will be created.
STRING point_list[] This value specifies the list of points defining the
starting points of the perpendicular curves.
STRING curve_list[] This value specifies the list of curves from which
the new curves are perpendicular.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each plane, point, curve input set. Each curve created will be displayed in
the graphics window.
712 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_normal (p. 541) in the PCL Reference Manual Examples.
Description:
This function constructs curves perpendicular to an existing set of curves and passing through a set
of points on the existing curves in a set of construction planes.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
REAL length This value specifies the length of the created
curves.
LOGICAL curve_rev_direction This value is set to TRUE if the curve direction is
to be flipped relative to the length.
STRING plane_list[] This value specifies the list of planes in which the
curves will be created.
STRING point_list[] This value specifies the list of points defining the
starting points of the perpendicular curves.
STRING curve_list[] This value specifies the list of curves from which
the new curves are perpendicular.
Chapter 3: Geometry Functions 713
Construct Actions
LOGICAL project_points This value specifies, when set to TRUE, that the
curves be projected onto the plane. When this
value is set to FALSE, the construction plane will
be translated to the point location and will still be
parallel to the original plane.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each plane, point, curve input set. Each curve created will be displayed in
the graphics window.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_2d_normal_v1 (p. 542) in the PCL Reference Manual Examples.
714 PCL Reference Manual
Construct Actions
Description:
This function constructs loft spline curves at the intersection between two sets of surfaces.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER intersect_option This value specifies the intersection option: 1 =
intersect between two surfaces, and 2 = intersect
between a plane and a surface.
STRING surface1_list[] This value specifies the list of surfaces to be
compared for intersection with the surfaces given
in the input value surface2_list. If the input value
intersect_option is set to 2, this input value will
provide the definitions for the intersecting planes.
STRING surface2_list[] This value specifies the list of surfaces to be
compared for intersection with the surfaces or
planes provided by the input value surface1_list.
REAL geo_tolerance This value specifies the maximum deviation
tolerance used during the creation of the
intersection curve.
REAL int_tolerance This value specifies a tolerance parameter. The
algorithm creates all points along the projected
curve so that the maximum distance lies between
them is the distance defined by this value.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Chapter 3: Geometry Functions 715
Construct Actions
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve per intersection will be created for each surface input set. Each curve created will be displayed
in the graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_intersect (p. 543) in the PCL Reference Manual Examples.
Description:
This function constructs finite length curves at the intersection of two planes.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
REAL length This value specifies the length of the curve.
STRING plane1_list[] This value specifies the list of planes to be
compared for intersection with the planes given in
the input value plane2_list.
STRING plane2_list[] This value specifies the list of planes to be
compared for intersection with the planes provided
by the input value plane1_list.
716 PCL Reference Manual
Construct Actions
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve per intersection will be created for each plane input set. Each curve created will be displayed
in the graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
None.
Chapter 3: Geometry Functions 717
Construct Actions
Description:
This function constructs finite length curves from the intersection of two planes with an option to
define the starting point of the curve at a specified point where the three input planes intersect.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
REAL length This values specifies the length of the curve.
STRING plane1_list[] This value specifies the list of planes to be
compared for intersection with the planes given in
the input value plane2_list.
STRING plane2_list[] This valu/nee specifies the list of planes to be
compared for intersection with the planes provided
by the input value plane1_list.
STRING plane3_list[] This value specifies the list of planes to be
compared for intersection with the planes provided
by the input value plane1_list and plane2_list. This
creates the intersection point for the start point of
the curve.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve per intersection will be created for each plane input set. Each curve created will be displayed
in the graphics window.
718 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
None.
Description:
This function constructs curves on a set of surfaces between two sets of points.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING surface_list[] This value specifies the list of surfaces to manifold
the curves onto.
STRING point1_list[] This value specifies the list of points defining the
starting points of the curves on the surfaces.
STRING point2_list[] This value specifies the list of points defining the
end points of the curves on the surfaces.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Chapter 3: Geometry Functions 719
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each surface, point input set. Each curve created will be displayed in the
graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_manifold_2point (p. 545) in the PCL Reference Manual Examples.
720 PCL Reference Manual
Construct Actions
Description:
This function constructs spline curves through a number of points manifolded onto a set of surfaces.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING surface[] This value specifies the surfaces to manifold the
curves onto.
STRING point_list[] This value specifies the list of points through
which the spline curves will be fitted.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
One curve will be created for each surface, point input set. Each curve created will be displayed in the
graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
1000301 There must be at least two points as input. The invalid value input was %A%.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
Chapter 3: Geometry Functions 721
Construct Actions
38000489 Unable to create a curve manifolded to the surface between the two input points.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_curve_manifold_npoint (p. 546) in the PCL Reference Manual Examples.
722 PCL Reference Manual
Construct Actions
Description:
This function will create constant or variable offset curves from other curves. It should be noted that
while nonplanar curves could be specified, the offset will occur in the least-squares plane of the input
curve. If the input curve is a straight line, then a direction vector is required.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER od_flag This value specifies the offset distance flag;
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the solid identifiers that are stored in the database and displayed in a viewport.
Example:
None.
Description:
This function constructs curves on a set of surfaces by projecting an existing set of curves along a
projection vector onto a set of surfaces.
Input:
STRING output_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING curve_list[] This value specifies the list of curves to project
onto the list of surfaces.
STRING surface_list[] This value specifies the list of surfaces onto which
the curves are to be projected.
LOGICAL delete_original This value is set to TRUE if the original curves are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
724 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of curves created and their IDs.
Each curve created will be displayed in the graphics window.
This function can display an information popup message form with the following messages:
This function can display a warning popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_curve_project (p. 547) in the PCL Reference Manual Examples.
726 PCL Reference Manual
Construct Actions
Description:
This function constructs a plane by the cross product of two vectors.
Input:
STRING output_ids[] This value specifies the plane ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of plane IDs.
STRING vector1_list[] This value specifies the first list of vectors.
STRING vector2_list[] This value specifies the second list of vectors.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This function can display an information popup message form with the following messages:
1000040 Duplicate %A% was not created at users request
This function can display a fatal popup message form with the following messages:
10000311 No intersections found between %A% and %A%.
38000845 Unable to acquire %I% words of virtual memory.
Description:
This function creates planes through three sets of points.
Input:
STRING output_ids[] This value specifies the plane ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of plane IDs.
STRING point1_list[] This value specifies the first set of points through
which the planes will pass.
Chapter 3: Geometry Functions 727
Construct Actions
Remarks:
This function displays a message listing the number of planes created and their IDs.
One plane will be created for each point set. Each plane will be displayed in the graphics window as it is
created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_plane_3point (p. 549) in the PCL Reference Manual Examples.
728 PCL Reference Manual
Construct Actions
Description:
This function creates planes normal to a set of curves at a set of points on the curves.
Input:
STRING output_ids[] This value specifies the plane ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of plane IDs.
INTEGER point_option This value specifies the point type: 1 = parametric
position, and 2 = point.
STRING curve_list[] This value specifies the curves which the planes
will be normal to.
STRING point_list[] This value specifies the points on the curves
defining the plane centroids, if the input value
point_option is set to 2. If the input value
point_option is set to 1, this value is ignored.
REAL u_position This value specifies the parametric position of the
point, if the input value point_option is set to 1. If
the input value point_option is set to 2, this value
is ignored.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of planes created and their IDs.
One plane will be created for each point. Each plane will be displayed in the graphics window as it
is created.
Chapter 3: Geometry Functions 729
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_plane_curve (p. 550) in the PCL Reference Manual Examples.
Description:
This function creates least squares planes from a set of points, curves, or surfaces.
Input:
STRING output_ids[] This value specifies the plane ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of plane IDs.
INTEGER leastsq_option This value specifies the least squares option: 1 =
from a set of points, 2 = from a curve, and 3 = from
a surface.
STRING entity_list[] This value specifies the set of points, curves, or
surfaces from which the planes will be created.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
730 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of planes created and their IDs.
One plane will be created for each set of points, curve or surface. Each plane will be displayed in the
graphics window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
1000744 Specified Least Squares Method value of %I% is invalid. Valid values are 1, 2, or 3.
38000438 No curves in the curve list define a unique least squares plane. Select a curve that is not
straight.
38000448 The points in the point list do not define a unique least squares plane. Select points that
are not colinear.
38000449 No surfaces in the surface list define a unique least squares plane. Select a surface with
a positive area.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_plane_leastsq (p. 551) in the PCL Reference Manual Examples.
Description:
This function constructs nrepeat planes from offsetting a plane.
Input:
STRING output_ids[] This value specifies the plane ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of plane IDs.
STRING offset_list[] This value specifies the list of offset values along
the vector normal defining the location of the
plane.
INTEGER nrepeat This value specifies the number of planes to offset.
Chapter 3: Geometry Functions 731
Construct Actions
STRING plane_list[] This value specifies the list of planes which will be
used to offset from.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This function can display an information popup message form with the following messages:
1000040 Duplicate %A% was not created at users request
This function can display a fatal popup message form with the following messages:
38000413 Zero length plane normal vector.
38000845 Unable to acquire %I% words of virtual memory.
732 PCL Reference Manual
Construct Actions
Description:
This function constructs a plane which is normal to an existing plane and also contains a specified
vector.
Input:
STRING output_ids[] This value specifies the plane ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of plane IDs.
STRING plane_list[] This value specifies the list of planes which will be
normal to the new plane.
STRING vector_list[] This value specifies the list of vectors which will
lie in the new plane.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
This function can display an information popup message form with the following messages:
1000040 Duplicate %A% was not created at users request
This function can display a fatal popup message form with the following messages:
38000157 Selected vector is normal to selected plane --Cannot construct unique normal
plane.
38000845 Unable to acquire %I% words of virtual memory.
Description:
This function creates planes from a set of points and vectors.
Input:
STRING output_ids[] This value specifies the plane ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of plane IDs.
Chapter 3: Geometry Functions 733
Construct Actions
STRING point_list[] This value specifies the point defining the location
at which to create the planes.
STRING vector_list[] This value specifies the vector normals from which
the planes will be created.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of planes created and their IDs.
One plane will be created for each point,vector set. Each plane will be displayed in the graphics window
as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
38000413 Zero length plane normal vector.
38000845 Unable to acquire %I% words of virtual memory.
Example:
None.
734 PCL Reference Manual
Construct Actions
Description:
This function creates planes that are tangent to a set of surfaces at a set of points on the surfaces.
Input:
STRING output_ids[] This value specifies the plane ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of plane IDs.
INTEGER point_option This value specifies the point type: 1 = parametric
position, and 2 = point.
STRING surface_list[] This value specifies the set of surfaces from which
the tangential planes will created.
STRING point_list[] This value specifies the point on the surface
defining the plane centroid if the input value
point_option is set to 2. If the input value
point_option is set to 1, this value is ignored.
REAL uv_position(2) This value specifies the u and v parametric
positions of the plane centroids if the input value
point_option is set to 1. If the input value
point_option is set to 2, this value is ignored.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of planes created and their IDs.
One plane will be created for each point. Each plane will be displayed in the graphics window as it is
created.
Chapter 3: Geometry Functions 735
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_plane_tangent (p. 553) in the PCL Reference Manual Examples.
736 PCL Reference Manual
Construct Actions
Description:
This function creates planes by interpolation along a set of curves. The normals of the generated
planes are along the curve tangents at the points of intersection between the planes and the curves.
Input:
STRING output_ids[] This value specifies the plane ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of plane IDs.
STRING curve_list[] This value specifies the set of curves from which
the planes are created.
REAL space_ratio This value specifies the space ratio of the
interpolation operation, if the interpolating is non-
uniform.
INTEGER num_planes This value specifies the number of planes per curve
to be created.
INTEGER method This value specifies the spacing for interpolating
planes based on: 1 = curve arc length or 2 = curve
parametric value.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of planes created and their IDs.
The number of planes defined by the input value num_planes will be created for each curve. Each plane
will be displayed in the graphics window as it is created.
Chapter 3: Geometry Functions 737
Construct Actions
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
1000507 Specified Parameterization Method value of %I% is invalid. Valid values are 1 and
2.
1000951 There must be at least two planes as input. The invalid value input was %A%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_plane_interpolate (p. 554) in the PCL Reference Manual Examples.
738 PCL Reference Manual
Construct Actions
Description:
This function creates planes from a set of vector normals.
Input:
STRING output_ids[] This value specifies the plane ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of plane IDs.
STRING offset_list[] This value specifies the offset value from the
vector normal defining the location at which to
create the planes.
STRING vector_list[] This value specifies the vector normals from which
the planes will be created.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of planes created and their IDs.
One plane will be created for each vector. Each plane will be displayed in the graphics window as it is
created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Chapter 3: Geometry Functions 739
Construct Actions
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
38000413 Zero length plane normal vector.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_plane_vector_normal (p. 555) in the PCL Reference Manual Examples.
Description:
This function constructs solids from one surface to another.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING surface1_list[] This value specifies the first set of surfaces for the
start of each solid.
STRING surface2_list[] This value specifies the second set of surfaces for
the end of each solid.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each pair of input surfaces. Each solid will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following message:
740 PCL Reference Manual
Construct Actions
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_solid_2surface (p. 557) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 741
Construct Actions
Description:
This function creates tri-parametric solids from one set of surfaces to another.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the solids should be
automatically aligned.
STRING surface1_list[] This value specifies the first set of surfaces for the
start of each solid.
STRING surface2_list[] This value specifies the second set of surfaces for
the end of each solid.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each pair of input surfaces. Each solid will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
742 PCL Reference Manual
Construct Actions
Example:
Please see sgm_const_solid_2surface_v1 (p. 558) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 743
Construct Actions
Description:
This function constructs solids which from three sets of surfaces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
INTEGER param_method This value specifies the parameterization method
to use: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING surface1_list[] This value specifies the first set of surfaces for the
start of each solid.
STRING surface2_list[] This value specifies the second set of surfaces for
the middle of each solid.
STRING surface3_list[] This value specifies the third set of surfaces for the
end of each solid.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each set of three input surfaces. Each solid will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_solid_3surface_v1 (p. 559) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 745
Construct Actions
Description:
This function constructs solids which from three sets of surfaces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the solids should be
automatically aligned.
INTEGER param_method This value specifies the parameterization method
to use: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING surface1_list[] This value specifies the first set of surfaces.
STRING surface2_list[] This value specifies the second set of surfaces.
STRING surface3_list[] This value specifies the third set of surfaces.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each pair of input surfaces. Each solid will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_solid_3surface_v2 (p. 560) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 747
Construct Actions
Description:
This function constructs solids which pass through a set of four surfaces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
INTEGER param_method This value specifies the parameterization method
to use: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING surface1_list[] This value specifies the first set of surfaces for the
start of each solid.
STRING surface2_list[] This value specifies the second set of surfaces for
the 1/3 point of each solid.
STRING surface3_list[] This value specifies the third set of surfaces for the
2/3 point of each solid.
STRING surface4_list[] This value specifies the fourth set of surfaces for
the end of each solid.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each set of four input surfaces. Each solid will be displayed in the graphics
window as it is created.
748 PCL Reference Manual
Construct Actions
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_solid_4surface_v1 (p. 562) in the PCL Reference Manual Examples.
Description:
This function creates tri-parametric solids from four surfaces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the solids should be
automatically aligned.
INTEGER param_method This value specifies the parameterization method
to use: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING surface1_list[] This value specifies the first set of surfaces.
STRING surface2_list[] This value specifies the second set of surfaces.
STRING surface3_list[] This value specifies the third set of surfaces.
STRING surface4_list[] This value specifies the fourth set of surfaces.
Chapter 3: Geometry Functions 749
Construct Actions
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each pair of input surfaces. Each solid will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_solid_4surface_v2 (p. 563) in the PCL Reference Manual Examples.
750 PCL Reference Manual
Construct Actions
Description:
This function constructs wedge shaped solids from five sets of surfaces forming their exterior faces.
The surfaces can be in any order and have any parametric orientation but they must define a valid
exterior face of a solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING surface1_list[] This value specifies the first set of surfaces
defining face one of each solid.
STRING surface2_list[] This value specifies the second set of surfaces
defining face two of each solid.
STRING surface3_list[] This value specifies the third set of surfaces
defining face three of each solid.
STRING surface4_list[] This value specifies the fourth set of surfaces
defining face four of each solid.
STRING surface5_list[] This value specifies the fifth set of surfaces
defining face five of each solid.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each set of input surfaces. Each solid will be displayed in the graphics
window as it is created.
Chapter 3: Geometry Functions 751
Construct Actions
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_solid_5face (p. 565) in the PCL Reference Manual Examples.
752 PCL Reference Manual
Construct Actions
Description:
This function constructs solids from six sets of surfaces forming their exterior faces. The surfaces
can be in any order and have any parametric orientation but they must define a valid exterior face
of a solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING surface1_list[] This value specifies the first set of surfaces
defining face one of each solid.
STRING surface2_list[] This value specifies the second set of surfaces
defining face two of each solid.
STRING surface3_list[] This value specifies the third set of surfaces
defining face three of each solid.
STRING surface4_list[] This value specifies the fourth set of surfaces
defining face four of each solid.
STRING surface5_list[] This value specifies the fifth set of surfaces
defining face five of each solid.
STRING surface6_list[] This value specifies the sixth set of surfaces
defining face six of each solid.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message
in the message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
Chapter 3: Geometry Functions 753
Construct Actions
One solid will be created for each set of input surfaces. Each solid will be displayed in the graphics
window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_solid_6face (p. 566) in the PCL Reference Manual Examples.
754 PCL Reference Manual
Construct Actions
Description:
This function creates solids be sweeping surfaces about a specified axis.
Input:
STRING output_labels[] This value specifies the labels of the solids to be
created.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to sweep each
surface.
REAL offset This value specifies the initial offset angle.
STRING coord_frame[] This value specifies the reference coordinate
frame.
STRING surface[] This value specifies the list of surfaces to be swept.
Output:
STRING created_labels[VIRTUAL] This value returns the labels of the created solids.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
Chapter 3: Geometry Functions 755
Construct Actions
Remarks:
This function displays the number of solids created and their labels.
One solid will be created for each surface. Each solid will be displayed in the graphics window.
Example:
Please see sgm_sweep_solid_arc (p. 568) in the PCL Reference Manual Examples.
Description:
This function creates hpats or solids between two sets of surfaces by decomposing two opposing solid
faces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
LOGICAL cubic This value is set to TRUE if the solid is to be a tri-
parametric cubic hyperpatch and to FALSE if it is
to be a simple solid.
STRING solid_face1_list[] This value specifies the first set of solid faces to
decompose.
STRING solid_face2_list[] This value specifies the second set of solid faces to
decompose.
756 PCL Reference Manual
Construct Actions
STRING vertex1_list[] This value specifies the first set of vertices for the
first face of the solids.
STRING vertex2_list[] This value specifies the second set of vertices for
the first face of the solids.
STRING vertex3_list[] This value specifies the third set of vertices for the
first face of the solids.
STRING vertex4_list[] This value specifies the forth set of vertices for the
first face of the solids.
STRING vertex5_list[] This value specifies the first set of vertices for the
second face of the solids.
STRING vertex6_list[] This value specifies the second set of vertices for
the second face of the solids.
STRING vertex7_list[] This value specifies the third set of vertices for the
second face of the solids.
STRING vertex8_list[] This value specifies the forth set of vertices for the
second face of the solids.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each face pair. Each solid will be displayed in the graphics window as it is
created.
This function can display a fatal popup message form with the following message:
Example:
Please see sgm_const_solid_decompose (p. 569) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 757
Construct Actions
Description:
This function creates tri-parametric solids by moving a surface through space along a defined axis
while simultaneously scaling and rotating the created solids.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING delta[] This value specifies a translation vector defining
the direction and magnitude of the extrusion
operation.
REAL scale This value specifies the scaling factor.
REAL angle This value specifies the angle to rotate the surface
around the translation vector during extrusion.
STRING origin[] This value specifies the point of origin of the
extrusion.
STRING coord_frame[] This value specifies the reference coordinate
frame.
STRING surface_list[] This value specifies the list of surfaces to be
extruded.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
758 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each input surface. Each solid will be displayed in the graphics window.
Example:
Please see sgm_const_solid_extrude (p. 571) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 759
Construct Actions
Description:
This function creates tri-parametric solids by moving director surfaces along paths defined by a set
of base surfaces translated to the origin of the director surface.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
REAL scale This value specifies the scaling factor.
INTEGER glide_option This value specifies the glide option to use: 0 =
normal project glide option, and 1 = fixed logic
option.
STRING director_surface[] This value specifies the list of surfaces along
which the base surfaces will be swept.
STRING base_surface[] This value specifies the list of surfaces that will be
swept along the director surfaces to form the
solids.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
760 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each set of base_surface and director_surface. The number of solids created
are set by the input value base_surface multiplied by the input value director_surface. Each solid will be
displayed in the graphics window.
Example:
Please see sgm_const_solid_glide (p. 572) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 761
Construct Actions
Description:
This function creates tri-parametric solids which are defined by projecting a distance along a unique
normal vector given by the thickness function, which itself has a unique value at each point on the
base surface The offset may be define a constant or a linear taper.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING thickness1[] This value specifies the constant thickness or the
first thickness at u=0; v=0 for the linear taper.
STRING thickness2[] This value is set to NULL if a constant thickness
has been specified, otherwise it is the second
thickness at u=0; v=1 for the linear taper.
STRING thickness3[] This value is set to NULL if a constant thickness
has been specified, otherwise it is the third
thickness at u=1; v=1 for the linear taper.
STRING thickness4[] This value is set to NULL if a constant thickness
has been specified, otherwise it is the fourth
thickness at u=1; v=0 for the linear taper.
LOGICAL normal_rev_direction This value is set to TRUE if the normal is to be
flipped or reversed.
STRING surface_list[] This value specifies the list of surfaces to be swept
using the normal option.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
762 PCL Reference Manual
Construct Actions
Remarks:
One solid will be created for each surface. Each solid will be displayed in the graphics window.
Example:
Please see sgm_const_solid_normal (p. 574) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 763
Construct Actions
Description:
This function constructs a tri-parametric solid which passes through a set of surfaces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
INTEGER param_method This value specifies the parameterization method
to use: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING surface_list[] This value specifies the set of surfaces from which
the solid will be constructed.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
38000493 The Surface interpolating Solid builder failed to create the evaluator table. Solid
was not created.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_solid_nsurface_v1 (p. 575) in the PCL Reference Manual Examples.
Description:
This function constructs a tri-parametric solid which passes through a set of surfaces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
LOGICAL auto_align This value specifies, when set to TRUE, that the
surfaces used to construct the solid should be
automatically aligned.
INTEGER param_method This value specifies the parameterization method
to use: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING surface_list[] This value specifies the set of surfaces from which
the solid will be constructed.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
This function is used in the implementation of the form that is displayed when Geometry, Create,
Solid, Surface, with the Option: set to N-Surfaces is selected from the switch bar.
Chapter 3: Geometry Functions 765
Construct Actions
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_solid_nsurface_v2 (p. 576) in the PCL Reference Manual Examples.
766 PCL Reference Manual
Construct Actions
Description:
This function creates a solid of revolution by revolving a set of surfaces about an axis of rotation.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to revolve each
surface in degrees.
REAL offset This value specifies the initial offset angle in
degrees.
STRING coord_frame[] This value specifies the reference coordinate
frame.
STRING surface_list[] This value specifies the list of surfaces to be
revolved.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
Chapter 3: Geometry Functions 767
Construct Actions
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38000003 No blob provided.
38000407 The Sweep Arc Solid builder failed to create the evaluator table. Solid was not
created.
38000427 The surface type used for this Action, Object, Method function is invalid. It must
be of a type that when created, has the default color of Green.
38000452 Unable to calculate a point on the solid.
38000492 Zero length vector in Solid %I% construction.
38000845 Unable to acquire %I% words of virtual memory.
Remarks:
This function displays a message listing the number of solids created and their IDs.
Each solid will be displayed in the graphics window.
Example:
Please see sgm_const_solid_revolve (p. 577) in the PCL Reference Manual Examples.
768 PCL Reference Manual
Construct Actions
Description:
This function constructs bi-parametric surfaces from two sets of curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One ruled surface will be created for each pair of input curves. Each surface will be displayed in the
graphics window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
38000494 The Curve interpolating Surface builder failed to create the evaluator table. Surface
was not created.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Please see sgm_const_surface_2curve (p. 578) in the PCL Reference Manual Examples.
Description:
This function creates manifold surfaces from two sets of curves and a set of surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING surface_list[] This value specifies the set of surfaces on which
manifold surface will be created.
LOGICAL object_surface This value is set to TRUE if the objects to be
created are parametric bicubic surfaces, or to
FALSE if the objects to be created are simply
trimmed surfaces.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
770 PCL Reference Manual
Construct Actions
One surface will be created for each set of input curves and surfaces. Each surface will be displayed in
the graphics window as it is created.
This function can display an information popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_surface_2curve_man (p. 580) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 771
Construct Actions
Description:
This function constructs bi-parametric surfaces from three sets of curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
INTEGER param_method This value specifies the parameterization method
to use: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING curve3_list[] This value specifies the third set of curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One bi-parametric surface will be created for each set of three input curves. Each surface will be
displayed in the graphics window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_surface_3curve_v1 (p. 581) in the PCL Reference Manual Examples.
Description:
This function constructs bi-parametric surfaces from four sets of curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
INTEGER param_method This value specifies the parameterization method
to use: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
STRING curve3_list[] This value specifies the third set of curves.
STRING curve4_list[] This value specifies the fourth set of curves.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Chapter 3: Geometry Functions 773
Construct Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One bi-parametric surface will be created for each set of four input curves. Each surface will be displayed
in the graphics window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_surface_4curve_v1 (p. 583) in the PCL Reference Manual Examples.
774 PCL Reference Manual
Construct Actions
Description:
This function constructs a bi-parametric surface from a set of curves.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
INTEGER param_method This value specifies the parameterization method
to use: 1 = chord length parameterization, and 2 =
uniform parameterization.
STRING curve_list[] This value specifies the list of curves used to define
the surface.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One bi-parametric surface will be created from the input curves. Each bi-parametric surface will be
displayed in the graphics window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_surface_ncurve_v1 (p. 584) in the PCL Reference Manual Examples.
Description:
This function will create constant offset surfaces from other surfaces .
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
REAL dist This value specifies the distance by which the
surface is normally offset.
INTEGER ncopies This value specifies the number of copies of the
offset surface to make.
LOGICAL guide_surface This value specifies whether the first surface in the
surface list is to be used as a guide surface to define
the offset direction for all surfaces in the list.
STRING surface_list[] This value specifies the input surface list to create
the offset surface(s) from.
Output:
STRING created_labels[VIRTUAL] This value returns a description of the created
surface identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
776 PCL Reference Manual
Construct Actions
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the solid identifiers that are stored in the database and displayed in a viewport.
Example:
None.
Description:
This function constructs bi-parametric surfaces by extraction from a set of solids at a specified
parametric position and in a specified parametric direction.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING solid_list[] This value specifies the list of solids from which
surfaces will be extracted.
INTEGER param_plane This value specifies the constant parametric plane
in which to create the surface: 1 = constant U
plane, 2 = constant V plane, and 3 = constant W
plane.
REAL param_pos This value specifies the parametric position in the
given parametric plane from which to extract the
surface.
Output:
STRING created_ids[VIRTUAL] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Chapter 3: Geometry Functions 777
Construct Actions
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One bi-parametric surface will be created for each parametric plane specified in each solid. Each bi-
parametric surface created will be displayed in the graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_surface_extract (p. 585) in the PCL Reference Manual Examples.
Description:
This function constructs bi-parametric surfaces from four sets of curves defining the boundaries of
the surfaces.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of surface IDs.
STRING curve1_list[] This value specifies the first set of curves.
STRING curve2_list[] This value specifies the second set of curves.
778 PCL Reference Manual
Construct Actions
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One bi-parametric surface will be created for each set of four input curves. Each bi-parametric surface
will be displayed in the graphics window as it is created.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_const_surface_edge (p. 587) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 779
Disassemble Actions
Disassemble Actions
PCL Reference Manual
This section is used to describe some of the functions used to implement the Disassemble actions.
Description:
This function disassembles a set of chains into constituent curves.
Input:
STRING chain_list[] This value specifies the set of chains to be
disassembled.
LOGICAL delete_original This value is set to TRUE if the original chains are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
The number of curves created from each chain is a function of how the chain was created. Each curve
will be displayed in the graphics window as it is created.
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function disassembles a set of trimmed surfaces into parent surfaces and edge curves.
Input:
STRING surface_list[] This value specifies the set of trimmed surfaces.
LOGICAL delete_original This value is set to TRUE if the original trimmed
surfaces are to be deleted. If this value is set to
FALSE, the original entities will not be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces and curves created and their IDs.
Each trimmed surface will be disassembled into a single surface and a number of curves that is a function
of how the trimmed surface was created. Each surface and curve will be displayed in the graphics window
as it is created.
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function disassembles a set of solids into subordinate surface faces.
Input:
STRING solid_list[] This value specifies the list of solids to be
disassembled.
LOGICAL delete_original This value is set to TRUE if the original solids are to
be deleted. If this value is set to FALSE, the original
entities will not be deleted.
Output:
STRING created_labels[] This value returns the a list of the labels for the
created entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
8107002 Last command aborted.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
The number of surfaces created from each depends on the geometry of the solid. Each surface will be
displayed in the graphics window as it is created.
Example:
Associate Actions
This section is used to describe some of the functions used to implement the Associate actions.
Description:
This function will associate finite element mesh beam elements to geometric curves.
Input:
STRING element_list[] This value specifies the list of elements to be used
for associating to the selected list of curves.
STRING geo_list[] This value specifies the list of geometry to which the
elements will be associated.
INTEGER flag This value specifies the actions the finite element
association should accomplish.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The input value flag can be set to either 8 or 9. A value of 8 indicates that a mesh definition is not created
on the curves to which elements must be associated. A value of 9 will create mesh definitions for each of
the selected curves that are successfully associated with an element.
Example:
To associate the unassociated nodes and elements in the database within geometric proximity to the
selected set of curves 1 through 10 :
sgm_assoc_element_curve_v1( , Curve 1:10, 9 )
To associate only specific elements (elements 1, 3 and 5 to 10) to curves 2 through 8:
sgm_assoc_element_curve_v1( Elm 1 3 5:10, Curve 2:8, 9 )
Chapter 3: Geometry Functions 783
Associate Actions
Description:
This function will associate finite element mesh point elements to geometric points.
Input:
STRING element_list[] This value specifies the list of elements to be used
for associating to the selected list of points.
STRING geo_list[] This value specifies the list of geometry to which
the elements will be associated.
INTEGER flag This value specifies the actions the finite element
association should accomplish.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
If elements are being associated to points the input value flag must be set to 0.
Example:
To associate the unassociated nodes and elements in the database within geometric proximity to the
selected set of points 1 through 10 :
sgm_assoc_element_point_v1( , Point 1:10, 0 )
To associate only specific elements (elements 1, 3 and 5 to 10) to points 2 through 8:
sgm_assoc_element_point_v1( Elm 1 3 5:10, Point 2:8, 0 )
784 PCL Reference Manual
Associate Actions
Description:
This function will associate finite element mesh solid elements to geometric solids.
Input:
STRING element_list[] This value specifies the list of elements to be used
for associating to the selected list of solids.
STRING geo_list[] This value specifies the list of geometry to which
the elements will be associated.
INTEGER flag This value specifies the actions the finite element
association should accomplish.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The input value flag can be set to either 32 or 33. A value of 32 indicates that a mesh definition is not
created on the edges of the solid to which elements must be associated. A value of 33 will create mesh
definitions for each of the edges of the selected solids that are successfully associated with an element.
Example:
To associate the unassociated nodes and elements in the database within geometric proximity to the
selected set of solids 1 through 10 :
sgm_assoc_element_solid_v1( , Solid 1:10, 32)
To associate only specific elements (elements 1, 3 and 5 to 10) to Solid 2 though 8:
sgm_assoc_element_solid_v1( Elm 1 3 5:10, Solid 2:8, 32)
Chapter 3: Geometry Functions 785
Associate Actions
Description:
This function will associate finite element mesh surface elements to geometric surfaces.
Input:
STRING element_list[] This value specifies the list of elements to be used
for associating to the selected list of surfaces.
STRING geo_list[] This value specifies the list of geometry to which
the elements will be associated.
INTEGER flag This value specifies the actions the finite element
association should accomplish.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The input value flag can be set to either 16 or 17. A value of 16 indicates that a mesh definition is not
created on the surface to which elements must be associated. A value of 17 will create mesh definitions
for each of the edges of the selected surfaces that are successfully associated with an element.
Example:
To associate the unassociated nodes and elements in the database within geometric proximity to the
selected set of surfaces 1 through 10 :
sgm_assoc_element_surface_v1( , Surface 1:10, 17 )
To associate only specific elements (elements 1 to 1000) to surface 2 through 8:
sgm_assoc_element_surface_v1( Elm 1000, Surface 2:8, 17 )
786 PCL Reference Manual
Associate Actions
Description:
This function associates a set of points to a set of curves.
Input:
STRING point_list[] This value specifies a list of point labels to be
associated with curves.
STRING curve_list[] This value specifies a list of curve labels to which
points will be associated.
Output:
STRING joined_list[] This value returns a list of joined entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000054 An invalid geometric entity type was used as input. The valid entity type to use is
%A%. Unable to process request.
38000931 Failed to associate the point(s) or curve(s).
Remarks:
Description:
This function associates a set of points to a set of surfaces.
Input:
STRING point_list[] This value specifies a list of point labels to be
associated with surfaces.
STRING surface_list[] This value specifies a list of surface labels to which
points will be associated.
Output:
STRING joined_list[] This value returns a list of joined entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000054 An invalid geometric entity type was used as input. The valid entity type to use is
%A%. Unable to process request.
38000931 Failed to associate the point(s) or curve(s).
Remarks:
Description:
This function associates a set of curves to another set of curves.
Input:
STRING curve_list1[] This value specifies a list of curve labels to be
associated with curves.
STRING curve_list2[] This value specifies a list of curve labels to which
curves will be associated.
Output:
STRING joined_list[] This value returns a list of joined entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000054 An invalid geometric entity type was used as input. The valid entity type to use is
%A%. Unable to process request.
38000931 Failed to associate the point(s) or curve(s).
Remarks:
Description:
This function associates a set of curves to a set of surfaces.
Input:
STRING curve_list[] This value specifies a list of curve labels to be
associated with surfaces.
STRING surface_list[] This value specifies a list of surface labels to which
curves will be associated.
Output:
STRING joined_list[] This value returns a list of joined entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000054 An invalid geometric entity type was used as input. The valid entity type to use is
%A%. Unable to process request.
38000931 Failed to associate the point(s) or curve(s).
Remarks:
Disassociate Actions
This section is used to describe some of the functions used to implement the Disassociate actions.
Description:
This function deletes all associations from a set of points.
Input:
STRING point_list[] This value specifies a set of point labels from which
all associations will be removed.
Output:
STRING entity_list[] This value returns a list of the disassociated entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000054 An invalid geometric entity type was used as input. The valid entity type to use is
%A%. Unable to process request.
Remarks:
Description:
This function deletes all associations from a set of curves.
Input:
STRING curve_list[] This value specifies a set of curve labels from which
all associations will be removed.
Output:
STRING entity_list[] This value returns a list of the disassociated entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000054 An invalid geometric entity type was used as input. The valid entity type to use is
%A%. Unable to process request.
Remarks:
The database is modified due to the deletion of the associations.
Associated curves that are marked by a filled yellow triangle are removed from the graphics window.
The viewport must be refreshed after this function is called to redisplay all entities.
Example:
Description:
This function deletes all point and curve associations from a set of surfaces.
Input:
STRING surface_list[] This value specifies a set of surface labels from
which all associations will be removed.
Output:
STRING entity_list[] This value returns a list of the disassociated entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000054 An invalid geometric entity type was used as input. The valid entity type to use is
%A%. Unable to process request.
Remarks:
Renumber Actions
This section is used to describe some of the functions used to implement the Renumber actions.
794 PCL Reference Manual
Renumber Actions
Description:
This function will renumber a selection of point, curve, surface, solid, plane, or vector identifiers in
either a consecutive manner beginning with a starting point, curve, surface, solid, plane, or vector
identifier or as directed by a selection of point,curve, surface, solid, plane, or vector identifiers.
Input:
INTEGER renum_option This value specifies the option for processing the
new_selection where:
1 = Starting ID(s)
2 = Offset ID
STRING entity_type This value specifies which geometric entity type
to renumber. Valid values include:
point
curve
surface
solid
plane
vector
STRING new_selection[] This value specifies a selection of point, curve,
surface, solid, plane, or vector identifiers to which
the original points, curves, surfaces, solids,
planes, or vectors will be renumbered. If there is
only one identifier in the selection the original
identifiers will be renumbered in a consecutive
manner. If more than one identifier is provided,
the identifiers in the input value original_selection
will be renumbered to match the identifiers
specified by this input value.
STRING original_selection[] This value specifies a selection of point, curve,
surface, solid, plane, or vector identifiers that will
be renumbered.
Output:
Chapter 3: Geometry Functions 795
Renumber Actions
Remarks:
Space is internally allocated for the string returned by the output value created_selection. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the point, curve, surface, solid, plane, and vector identifiers that are stored in
the database and displayed in a viewport.
Example:
None.
796 PCL Reference Manual
Sweep Actions
Sweep Actions
This section is used to describe some of the functions used to implement the Sweep actions.
Chapter 3: Geometry Functions 797
Sweep Actions
Description:
This function creates hyperpatches arcing about a set of surfaces.
Input:
STRING hpat_labels[] This value specifies the labels of the hyperpatches to be
created.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to sweep each surface in
degrees.
REAL offset This value specifies the initial offset angle in degrees.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_hpats This value specifies the number of hyperpatches to be
created for each surface.
STRING surface_list[] This value specifies the list of surfaces from which
hyperpatches will be created.
Output:
STRING created_labels[] This value returns the labels of the created hyperpatches.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000210 Angle of rotation for a parametric entity is greater than 180 degrees.
1000211 The length of the Axis equals zero.
1000242 Rotation is approximately parallel to the surface.
1000901 Zero length vector in Hpat %I% construction.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
798 PCL Reference Manual
Sweep Actions
Remarks:
This function displays the number of hyperpatches created and their labels.
The input value num_hpats specifies the number of hyperpatches that will be created for each surface.
Each hyperpatch will be displayed in the graphics window.
Example:
Description:
This function creates hyperpatches by extruding a set of surfaces along a vector while simultaneously
scaling and rotating the created hyperpatches.
Input:
STRING hpat_labels[] This value specifies the labels of the hyperpatches to be
created.
STRING delta[] This value specifies the translation vector along which the
extrusion will occur and its magnitude.
REAL scale_u This value specifies the scaling factor to be used to scale
the surface as it is extruded in the u direction.
REAL scale_v This value specifies the scaling factor to be used to scale
the surface as it is extruded in the v direction.
REAL angle This value specifies the angle to rotate the hyperpatch
around the translation vector during extrusion in degrees.
STRING origin[] This value specifies the point to be used as the origin for
the extrusion operation.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_hpats This value specifies the number of hyperpatches to be
created for each surface.
STRING surface_list[] This value specifies the list of surfaces to be extruded.
Output:
STRING created_labels[] This value returns the labels of the created hyperpatches.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000211 The length of the Axis equals zero.
1000241 Unable to extrude hyperpatch because the surface is too degenerate.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
800 PCL Reference Manual
Sweep Actions
Remarks:
This function displays the number of hyperpatches created and their labels.
The input value num_hpats specifies the number of hyperpatches that will be created for each surface.
Each hyperpatch will be displayed in the graphics window.
Example:
Description:
This function creates hyperpatches by gliding a set of base surfaces along a set of director curves.
Input:
STRING hpat_labels[] This value specifies the labels of the hyperpatches to
be created.
REAL scale This value specifies the scaling factor.
INTEGER glide_option This value specifies the glide option to use: 0 = normal
project glide option, and 1 = fixed logic option.
STRING director_curves[] This value specifies the list of curves along which the
base surface will be swept.
STRING base_surfaces[] This value specifies the list of surfaces that will be
swept along the director curves to form the
hyperpatches.
Output:
STRING created_labels[] This value returns the labels of the hyperpatches
created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000225 Unable to do glide option.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
802 PCL Reference Manual
Sweep Actions
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
Remarks:.
This function displays the number of hyperpatches created and their labels.
One hyperpatch will be created for each set of base_surfaces and director_curves. The number of
hyperpatches created are set by the input value base_surfaces multiplied by the input value
director_curves. Each hyperpatch will be displayed in the graphics window.
Example:
Description:
This function creates hyperpatches normal to the specified list of curves.
Input:
STRING hpat_labels[] This value specifies the labels of the hyperpatches to be
created.
STRING thickness1[] This value specifies either the constant thickness or the
first thickness.
STRING thickness2[] This value is set to NULL if the input value thickness1
specifies a constant thickness, otherwise it is the second
thickness.
STRING thickness3[] This value is set to NULL if the input value thickness1
specifies a constant thickness, otherwise it is the third
thickness.
STRING thickness4[] This value is set to NULL if the input value thickness1
specifies a constant thickness, otherwise it is the fourth
thickness.
INTEGER num_hypats This value specifies the number of surfaces to be created
for each curve.
LOGICAL normal_rev_direction This value is set to TRUE if the normal is to be flipped
or reversed.
STRING surface_list[] This value specifies the list of surfaces to be swept using
the normal option.
Output:
STRING created_labels[] This value returns the labels of the created hyperpatches.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000712 Unable to compute the tangent and normal vectors due to a non-removable
degeneracy or a singularity.
1000901 Zero length vector in Hpat %I% construction.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
804 PCL Reference Manual
Sweep Actions
Remarks:
The input value num_hpats specifies the number of hyperpatches that will be created for each curve. Each
hyperpatch will be displayed in the graphics window.
Example:
Description:
This function creates lines arcing about the specified list of points.
Input:
STRING line_labels[] This value specifies the labels of the lines to be created.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to sweep each point in
degrees.
REAL offset This value specifies the initial offset angle in degrees.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_lines This value specifies the number of lines that will be created
for each point.
STRING point_list[] This value specifies the list of points to be swept.
Output:
STRING created_labels[] This value returns the labels of the lines created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
1000210 Angle of rotation for a parametric entity is greater than 180 degrees.
1000211 The length of the Axis equals zero.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
806 PCL Reference Manual
Sweep Actions
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
Remarks:
This function displays the number of lines created and their labels.
The input value num_lines specifies the number of lines that will be created for each point. Each line will
be displayed in the graphics window.
Example:
Description:
This function creates lines from a set of points using the involute sweep operation.
Input:
STRING line_labels[] This value specifies the labels of the lines to be created.
STRING axis[] This value specifies the axis of rotation.
INTEGER option This value specifies the option to use in creating the
involute. If the input value option is set to 1 then the radii
method is used, otherwise the angle method is used.
REAL scalar1 This value specifies a scalar value used in one of two ways
depending on the input value option. If the angle method is
used, this value specifies the angle to unwind the line. If the
radii method is used, this value specifies the base radius of
the bobbin.
REAL scalar2 This value specifies a scalar value depending on the value
of option. If the angle method is used, this is the starting
angle of the line. If the radii method is used, this is the stop
radius of the line.
INTEGER num_lines This value specifies the number of lines to create for each
point.
STRING coord_frame[] This value specifies the reference coordinate frame.
STRING point_list[] This value specifies the list of points to be swept.
Output:
STRING created_labels[] This value returns the labels of the lines created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000211 The length of the Axis equals zero.
1000226 The angle which the involute traverses must be positive.
1000227 The starting angle of the involute must be positive.
1000228 The radius of the base circle must be positive.
1000229 The stop radius of the involute must be larger than the base radius.
808 PCL Reference Manual
Sweep Actions
Remarks:
This function displays the number of lines created and their labels.
The input value num_lines specifies the number of lines that will be created for each point. Each line will
be displayed in the graphics window.
Example:
Description:
This function creates patches arcing about the specified list of curves.
Input:
STRING patch_labels[] This value specifies the labels of the patches to be created.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the total angle to sweep each point in
degrees.
REAL offset This value specifies the initial offset angle in degrees.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_patches This value specifies the number of patches to create for
each curve.
STRING curve_list[] This value specifies the list of curves to be swept.
Output:
STRING created_labels[] This value returns the labels of the patches created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
1000210 Angle of rotation for a parametric entity is greater than 180 degrees.
1000211 The length of the Axis equals zero.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
810 PCL Reference Manual
Sweep Actions
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
38000451 Unable to calculate a point on the surface.
Remarks:
This function displays the number of patches created and their labels.
The input value num_patches specifies the number of patches that will be created for each curve. Each
patch will be displayed in the graphics window.
Example:
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
Remarks:
This function displays the number of patches created and their labels.
The input value num_patches specifies the number of patches that will be created for each curve. Each
patch will be displayed in the graphics window.
Example:
Description:
This function creates patches by gliding a set of base curves along a set of director curves.
Input:
STRING patch_labels[] This value specifies the labels of the patches to be
created.
REAL scale This value specifies the scaling factor.
INTEGER glide_option This value specifies the glide option to use: 0 = normal
project glide option, and 1 = fixed logic option.
STRING director_curves[] This value specifies the list of curves along which the
base curve will be swept.
STRING base_curve[] This value specifies the list of curves that will be swept
along the director curves to form the patches.
Output:
STRING created_labels[] This value returns the labels of the patches created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000225 Unable to do glide option.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
814 PCL Reference Manual
Sweep Actions
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
Remarks:
This function displays the number of patches created and their labels.
One patch will be created for each set of base_patches and director_curves. The number of patches
created are set by the input value base_patches multiplied by the input value director_curves. Each patch
will be displayed in the graphics window.
Example:
Description:
This function creates patches normal to the specified list of curves.
Input:
STRING patch_labels[] This value specifies the labels of the patches to be
created.
STRING thickness1[] This value specifies either the constant thickness or the
first thickness.
STRING thickness2[] This value is set to NULL if the input value thickness1
specifies a constant thickness, otherwise it is the second
thickness.
STRING origin[] This value specifies the point to be used as origin of the
normal vector.
INTEGER num_patches This value specifies the number of patches to be created
for each curve in the input list.
LOGICAL normal_rev_direction This value is set to TRUE if the normal is to be flipped
or reversed.
STRING curve_list[] This value specifies the list of curves to be swept using
the normal option.
Output:
STRING created_labels[] This value returns the labels of the patches created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000211 The length of the Axis equals zero.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
816 PCL Reference Manual
Sweep Actions
Remarks:
This function displays the number of patches created and their labels.
The input value num_patches specifies the number of patches that will be created for each curve. Each
curve will be displayed in the graphics window.
Example:
Verify Actions
This section is used to describe some of the functions used to implement the Verify actions
Description:
This function will verify a list of surfaces for the existence of free edges between adjacent surfaces.
Input:
STRING surface_list[] This value specifies the surface list.
REAL verify_tolerance This value specifies the tolerance used to determine
existence of free edges between adjacent surfaces.
INTEGER verify_type This value specifies the verification type: 1 =the surface
edge topology in the database will be used to check for
free edges, and 2 = the surface edges will be extracted
from adjacent surface boundaries and will be
geometrically compared within the value defined by the
input value verify tolerance to determine if free edges
exist.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the information whether or not free edges exist.
Surface normals may be reversed.
Each free edge will be highlighted and a diamond symbol placed at its centroid.
This function can display an information popup message form with the following message:
This function can display a warning popup message form with the following message:
38000054 Free edges and/or non-manifold edges exist. Free edges may be due to edges not
matching directly or a missing face. Non-manifold edges are due to more than two
surfaces connecting at the same edges. Edges are highlighted and marked with
primary markers for free edges and secondary markers for non-manifold edges.
This function can display a fatal popup message form with the following messages:
Example:
Please see sgm_verify_surface_boundary (p. 531) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 819
Verify Actions
Description:
Check the entire database for duplicate surfaces and optionally delete them.
Input:
LOGICAL delete_surfaces This value specifies, when set to TRUE, that any duplicate
surfaces will be deleted. When this value is set to FALSE,
duplicate surfaces will not be deleted.
LOGICAL delete_high This value specifies, when set to TRUE, that the surfaces
with the higher identifier values will be deleted from sets
of duplicate surfaces. If this value is set to FALSE, the
duplicate surfaces with the lower identifier values will be
deleted from sets of duplicate surfaces. Duplicate surfaces
will be deleted only when the input value delete_surfaces
is set to TRUE.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the Geometry switch bar form that is displayed when
the action is set to Verify, the object is set to Surface, and the test is set to Duplicates.
Example:
820 PCL Reference Manual
Transform Actions
Transform Actions
This section is used to describe some of the functions used to implement the Transform actions.
Chapter 3: Geometry Functions 821
Transform Actions
Description:
This function creates coordinate frames by rotating a set of coordinate frames around an axis in a
reference coordinate frame.
Input:
STRING output_labels[] This value specifies the labels of the coordinate frames to
be created.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the angle of rotation in degrees.
REAL offset This value specifies the offset angle between the
coordinate frame and the beginning of the angle of rotation
in degrees.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of times to repeat this
transformation operation on each created coordinate frame.
LOGICAL delete_original This value is set to TRUE if the original coordinate frames
are to be deleted. If this value is set to FALSE, the original
entities will not be deleted.
STRING coord_list[] This value specifies the list of coordinate frames to be
rotated.
Output:
STRING created_labels[] This value returns the labels of the coordinate frames
created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000064 Overwrite of existing entity not permitted.
1000211 The length of the Axis equals zero.
1000216 Unable to properly process the output labels.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
822 PCL Reference Manual
Transform Actions
Remarks:
This function displays the number of coordinate frames created and their labels. If the original coordinate
frames are to be deleted, the number of coordinate frames deleted and their labels will also be displayed.
The input value num_repeat specifies the number of coordinate frames that will be created for each
coordinate frame specified by the input value coord_list. Each coordinate frame will be displayed in the
graphics window.
Example:
Description:
This function creates coordinate frames by translating a set of coordinate frames in a reference
coordinate frame.
Input:
STRING output_labels[] This value specifies the labels of the coordinate frames
to be created.
STRING delta[] This value specifies the translation vector.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of translations for each
coordinate frame.
LOGICAL delete_original This value is set to TRUE if the original coordinate
frames are to be deleted. If this value is set to FALSE,
the original entities will not be deleted.
STRING coord_list[] This value specifies the list of coordinate frames to be
translated.
Output:
STRING created_labels[] This value returns the labels of the coordinate frames
created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000064 Overwrite of existing entity not permitted.
1000216 Unable to properly process the output labels.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
824 PCL Reference Manual
Transform Actions
Remarks:
This function displays the number of coordinate frames created and their labels. If the original coordinate
frames are to be deleted, the number of coordinate frames deleted and their labels will also be displayed.
The input value num_repeat specifies the number of coordinate frames that will be created for each
coordinate frame specified by the input value coord_list. Each coordinate frame will be displayed in the
graphics window.
Example:
Description:
This function creates coordinate frames by translating a set of coordinate frames in a reference
coordinate frame.
Input:
STRING output_labels[] This value specifies the labels of the coordinate frames to
be created.
STRING delta[] This value specifies the direction vector.
REAL magnitude This value specifies the vector magnitude.
LOGICAL reverse_direction This value is set to TRUE if the direction vector is to be
reversed. If this value is set to FALSE, the direction vector
will not be reversed.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of translations for each
coordinate frame.
LOGICAL delete_original This value is set to TRUE if the original coordinate frames
are to be deleted. If this value is set to FALSE, the original
entities will not be deleted.
STRING coord_list[] This value specifies the list of coordinate frames to be
translated.
Output:
STRING created_labels[] This value returns the labels of the coordinate frames
created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000064 Overwrite of existing entity not permitted.
1000216 Unable to properly process the output labels.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
826 PCL Reference Manual
Transform Actions
Remarks:
This function displays the number of coordinate frames created and their labels. If the original coordinate
frames are to be deleted, the number of coordinate frames deleted and their labels will also be displayed.
The input value num_repeat specifies the number of coordinate frames that will be created for each
coordinate frame specified by the input value coord_list. Each coordinate frame will be displayed in the
graphics window.
Example:
Description:
This function creates parametric cubic curves by performing vector sums of the coordinate locations
of two sets of curves.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value is set to
an empty string or to #, the function will automatically
allocate and assign a sequential list of curve IDs.
STRING origin_1[] This value specifies the origin of the vectors for the first set
of curves.
STRING origin_2[] This value specifies the origin of the vectors for the second
set of curves.
REAL scales_1(3) This value specifies the factor to be used to scale the first
set of curve vectors.
REAL scales_2(3) This value specifies the factor to be used to scale the
second set of curve vectors.
STRING curve_list1[] This value specifies the first curve list.
STRING curve_list2[] This value specifies the second curve list.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
828 PCL Reference Manual
Transform Actions
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
Remarks:
One curve will be created for each set of curves in the input values curve_list1 and curve_list2. Each
curve created will be displayed in the graphics window.
Example:
Remarks:
This function displays the number of points created and their labels. If the original points are to be
deleted, the number of points deleted and their labels will also be displayed.
One point will be created for each point translated. Each point created will be displayed in the graphics
window.
Example:
Description:
This function will create points by mirroring a set of points.
Input:
STRING point_labels[] This value specifies the labels of the points to be created.
STRING plane[] This value specifies the mirror plane.
REAL offset This value specifies the final offset from the mirror
plane.
LOGICAL delete_original This value is set to TRUE if the original points are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING point_list[] This value specifies the list of points to be mirrored.
Output:
STRING created_labels[] This value returns the labels of the points created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
832 PCL Reference Manual
Transform Actions
Remarks:
This function displays the number of points created and their labels. If the original points are to be
deleted, the number of points deleted and their labels will also be displayed.
One point will be created for each point mirrored. Each point created will be displayed in the graphics
window.
Example:
Description:
This function creates points by simultaneously translating, scaling, rotating, and warping a set of
points.
Input:
STRING point_labels[] This value specifies the labels of the points to be created.
STRING coord_frame[] This value specifies the reference coordinate frame.
STRING origin[] This value specifies the origin for the transformation.
STRING translation[] This value specifies a translation vector defining the
direction and distance of a translation operation. This
value will be used only if a translation operation has
been specified with the input value rotation_matrix.
REAL rotation_matrix(3,3) This value specifies the translation, scaling, rotation, and
warp operations to be done on the set of points. See the
remarks below for more information.
LOGICAL delete_original This value is set to TRUE if the original points are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING point_list[] This value specifies the list of points to be transformed.
Output:
STRING created_labels[] This value returns the labels of the points created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
834 PCL Reference Manual
Transform Actions
Remarks:
This function displays the number of points created and their labels. If the original points are to be
deleted, the number of points deleted and their labels will also be displayed.
One point will be created for each point transformed. Each point created will be displayed in the graphics
window.
The input value rotation_matrix can be used to specify a translation operation by placing the value 1
along the positive diagonal of the matrix and defining a vector for the input value translation:
1 1 0 0
2 0 1 0
3 0 0 1
The input value rotation_matrix can be used to specify a scaling operation by placing nonzero values
along the positive diagonal of the matrix. If the input value translation is defined the set of points will be
both translated and scaled:
1 2 0 0
2 0 2 0
3 0 0 2
The input value rotation_matrix can be used to specify a mirroring operation by placing a negative value
along the positive diagonal of the matrix at the position that represents the normal to the mirror plane. A
negative value placed at rotation_matrix(1,1) would represent a mirror plane along the XY axis,
rotation_matrix(2,2) the YZ axis, and rotations_matrix(3,3) the XZ plane. The example below would
mirror a set of points around the XY plane, scale the points, and if the input value translation is defined,
translate the set of points as well:
Chapter 3: Geometry Functions 835
Transform Actions
1 -3 0 0
2 0 3 0
3 0 0 3
The input value rotation_matrix can be used to specify rotation and warp operations by placing values
that are not along the positive diagonal of the matrix. The example below would cause a rotation
operation only to take place. If the values in the input value rotation_matrix describe a non-orthogonal
matrix the set of point would be warped as a function of position:
1 0 1 1
2 1 0 1
3 1 1 0
Example:
Description:
This function creates points by simultaneously translating, scaling, rotating, and warping a set of
points.
Input:
STRING point_labels[] This value specifies the labels of the points to be created.
STRING coord_frame[] This value specifies the reference coordinate frame.
STRING origin[] This value specifies the origin for the transformation.
STRING translation[] This value specifies a translation vector defining the
direction and distance of a translation operation. This
value will be used only if a translation operation has
been specified with the input value rotation_matrix.
STRING columns[](3) This value specifies the translation, scaling, rotation,
and warp operations to be done on the set of points. The
three strings represent the three column vectors which
combine to create the rotation matrix.
LOGICAL delete_original This value is set to TRUE if the original points are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING point_list[] This value specifies the list of points to be transformed.
Output:
STRING created_labels[] This value returns the labels of the points created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
Chapter 3: Geometry Functions 837
Transform Actions
Remarks:
This function displays the number of points created and their labels. If the original points are to be
deleted, the number of points deleted and their labels will also be displayed. One point will be created for
each point transformed. Each point created will be displayed in the graphics window. The input value
columns can be used to specify a translation operation by specifying the rotation matrix columns
accordingly. Refer to the documentation for function, asm_transform_grid_mscale.
Example:
None.
Description:
This function creates points by pivoting them around a point from one point to another.
Input:
STRING point_labels[] This value specifies the labels of the points to be
created.
STRING pivot_point_1[] This value specifies the pivot point.
STRING pivot_point_2[] This value specifies the point which defines the
beginning of the pivot operation.
STRING pivot_point_3[] This value specifies the pivot which defines the end
of the pivot operation.
LOGICAL delete_original This value is set to TRUE if the original points are to
be deleted. If this value is set to FALSE, the original
entities will not be deleted.
STRING point_list[] This value specifies the list of points to be pivoted.
Output:
STRING created_labels[] This value returns the labels of the points created.
838 PCL Reference Manual
Transform Actions
Remarks:
This function displays the number of points created and their labels. If the original points are to be
deleted, the number of points deleted and their labels will also be displayed.
One point will be created for each point transformed. Each point created will be displayed in the graphics
window.
Example:
Description:
This function creates points by translating and rotating a set of points.
Chapter 3: Geometry Functions 839
Transform Actions
Input:
STRING point_labels[] This value specifies the labels of the points to be created.
STRING point_1[] This value specifies the first point describing the location
and orientation from which the set of points will be
transformed.
STRING point_2[] This value specifies the second point describing the
location and orientation from which the set of points will
be transformed.
STRING point_3[] This value specifies the third point describing the location
and orientation from which the set of points will be
transformed.
STRING point_4[] This value specifies the first point describing the location
and orientation to which the set of points will be
transformed.
STRING point_5[] This value specifies the second point describing the
location and orientation to which the set of points will be
transformed.
STRING point_6[] This value specifies the third point describing the location
and orientation to which the set of points will be
transformed.
LOGICAL delete_original This value is set to TRUE if the original points are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING point_list[] This value specifies the list of points to be transformed.
Output:
STRING created_labels[] This value returns the labels of the points created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000211 The length of the Axis equals zero.
1000302 The three points specified are nearly collinear.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
840 PCL Reference Manual
Transform Actions
Remarks:
This function displays the number of points created and their labels. If the original points are to be
deleted, the number of points deleted and their labels will also be displayed.
One point will be created for each point transformed. Each point created will be displayed in the graphics
window.
Example:
Description:
This function creates points by rotating a set of points around an axis.
Input:
STRING point_labels[] This value specifies the labels of the points to be created.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the angle of rotation in degrees.
REAL offset This value specifies the offset angle between the point
and the beginning of the angle of rotation in degrees.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of rotations for each
point.
LOGICAL delete_original This value is set to TRUE if the original points are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING point_list[] This value specifies the list of points to be rotated.
Output:
STRING created_labels[] This value returns the labels of the grids created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000211 The length of the Axis equals zero.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
842 PCL Reference Manual
Transform Actions
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
Remarks:
This function displays the number of points created and their labels. If the original points are to be
deleted, the number of points deleted and their labels will also be displayed.
The input value num_repeat specifies the number of points that will be created for each point specified
by the input value point_list. Each point will be displayed in the graphics window.
Example:
Description:
This function creates points by scaling a set of points.
Input:
STRING point_labels[] This value specifies the labels of the points to be created.
STRING origin[] This value specifies the origin for the scaling operation.
It is interpreted in the local coordinate system as
cartesian or curvilinear depending on the value of the
input value trans_type.
REAL scale(3) This value specifies three scaling values. It is interpreted
in the local coordinate system as cartesian or curvilinear
depending on the value of the input value trans_type.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of scaling operations to
be done for each point.
LOGICAL trans_type This value is set to TRUE if the transformation is to be
done using a curvlinear coordinate frame or to FALSE to
use a cartesian coordinate frame.
LOGICAL delete_original This value is set to TRUE if the original points are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING point_list[] This value specifies the list of points to be scaled.
Output:
STRING created_labels[] This value returns the labels of the points created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
844 PCL Reference Manual
Transform Actions
Remarks:
This function displays the number of points created and their labels. If the original points are to be
deleted, the number of points deleted and their labels will also be displayed.
The input value num_repeat specifies the number of points that will be created for each point specified
by the input value point_list. Each point will be displayed in the graphics window.
Example:
Description:
This function creates points by translating a set of points.
Input:
STRING point_labels[] This value specifies the labels of the points to be created.
STRING delta[] This value specifies the translation vector. It is interpreted
in the local coordinate system as cartesian or curvilinear
depending on the value of the input value trans_type.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of translations for each
point.
LOGICAL trans_type This value is set to TRUE if the transformation is to be done
using a curvlinear coordinate frame or to FALSE to use a
cartesian coordinate frame.
LOGICAL delete_original This value is set to TRUE if the original points are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING point_list[] This value specifies the list of points to be translated.
Output:
STRING created_labels[] This value returns the labels of the points created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
846 PCL Reference Manual
Transform Actions
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
Remarks:
This function displays the number of points created and their labels. If the original points are to be
deleted, the number of points deleted and their labels will also be displayed.
The input value num_repeat specifies the number of points that will be created for each point specified
by the input value point_list. Each point will be displayed in the graphics window.
Example:
Description:
This function creates points by translating a set of points.
Input:
STRING point_labels[] This value specifies the labels of the points to be created.
STRING delta[] This value specifies the direction vector. It is interpreted in
the local coordinate system as cartesian or curvilinear
depending on the value of the input value trans_type.
REAL magnitude This value specifies the vector magnitude.
LOGICAL reverse_direction This value is set to TRUE if the direction vector is to be
reversed. If this value is set to FALSE, the direction vector
is not reversed. ???
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of translations for each
point.
LOGICAL trans_type This value is set to TRUE if the transformation is to be done
using a curvlinear coordinate frame or to FALSE to use a
cartesian coordinate frame.
LOGICAL delete_original This value is set to TRUE if the original points are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING point_list[] This value specifies the list of points to be translated.
Output:
STRING created_labels[] This value returns the labels of the points created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
848 PCL Reference Manual
Transform Actions
Remarks:
This function displays the number of points created and their labels. If the original points are to be
deleted, the number of points deleted and their labels will also be displayed.
The input value num_repeat specifies the number of points that will be created for each point specified
by the input value point_list. Each point will be displayed in the graphics window.
Example:
Please see asm_transform_grid_translate (p. 631) in the .???set external cross reference
Chapter 3: Geometry Functions 849
Transform Actions
Description:
This function creates points by performing vector sums of the coordinate locations of two sets of points.
Input:
STRING point_labels[] This value specifies the labels of the points to be created.
STRING origin_1[] This value specifies the origin of the vectors for the first set
of points.
STRING origin_2[] This value specifies the origin of the vectors for the second
set of points.
REAL scales_1(3) This value specifies the factor to be used to scale the first
set of point vectors.
REAL scales_2(3) This value specifies the factor to be used to scale the second
set of point vectors.
STRING point_list1[] This value specifies the first point list.
STRING point_list2[] This value specifies the second point list.
Output:
STRING created_labels[] This value returns the labels of the points created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
850 PCL Reference Manual
Transform Actions
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
Remarks:
This function displays the number of points created and their labels.
One point will be created for each set of curves in the input values point_list1 and point_list2. Each point
created will be displayed in the graphics window.
Example:
Description:
This function will create lines by mirroring a set of lines.
Input:
STRING line_labels[] This value specifies the labels of the lines to be created.
STRING plane[] This value specifies the mirror plane.
REAL offset This value specifies the final offset from the mirror plane.
LOGICAL reverse This value is set to TRUE if the new line is to be reversed
such that its parametric direction will match that of the
original line.
LOGICAL delete_original This value is set to TRUE if the original lines are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING line_list[] This value specifies the list of lines to be mirrored.
Output:
STRING created_labels[] This value returns the labels of the lines created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000052
%A% %I% is not an ASM Entity and was not written to the Patran Neutral File.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
852 PCL Reference Manual
Transform Actions
Remarks:
This function displays the number of lines created and their labels. If the original lines are to be deleted,
the number of lines deleted and their labels will also be displayed.
One line will be created for each line mirrored. Each line created will be displayed in the graphics
window.
Example:
Description:
This function will create patches by mirroring a set of patches.
Input:
STRING patch_labels[] This value specifies the labels of the patches to be created.
STRING plane[] This value specifies the mirror plane.
REAL offset This value specifies the offset distance from the mirror
plane.
LOGICAL reverse This value is set to TRUE if the new patch is to be reversed
such that its normal will match that of the original patch. If
this value is set to FALSE, the normal will not be reversed.
LOGICAL delete_original This value is set to TRUE if the original patches are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING patch_list[] This value specifies the list of patches to be mirrored.
Output:
STRING created_labels[] This value returns the labels of the patches created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000052
%A% %I% is not an ASM Entity and was not written to the Patran Neutral File.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
854 PCL Reference Manual
Transform Actions
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
Remarks:
This function displays the number of patches created and their labels. If the original patches are to be
deleted, the number of patches deleted and their labels will also be displayed.
One patch will be created for each patch mirrored. Each patch created will be displayed in the graphics
window.
Example:
Description:
This function creates entities by translating a set of entities from one coordinate frame to a second
coordinate frame. The entities created will have the same parametric locations relative to the new
coordinate frame that they had to the original coordinate frame. Use this function for Parasolid solids.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
STRING coord_frame_1[] This value specifies the coordinate frame from which the
set of entities will be translated.
STRING coord_frame_2[] This value specifies the coordinate frame to which the
entities will be translated.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be transformed.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
856 PCL Reference Manual
Transform Actions
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
One entity will be created for each entity transformed. Each entity created will be displayed in the
graphics window.
Example:
None.
Chapter 3: Geometry Functions 857
Transform Actions
Description:
This function will create entities by mirroring a set of entities. Use this function for Parasolid solids.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be created.
STRING entity_type[] This value specifies the type of entity. This value can be set
to: point, curve, surface, solid, plane, or
vector.
STRING plane[] This value specifies the mirror plane.
REAL offset This value specifies the offset distance from the mirror
plane.
LOGICAL reverse This value is set to TRUE if the new entities are to be
reversed. If this value is set to FALSE, the entities will not
be reversed.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be mirrored.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
858 PCL Reference Manual
Transform Actions
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
One entity will be created for each entity mirrored. Each entity created will be displayed in the graphics
window.
Example:
None.
Chapter 3: Geometry Functions 859
Transform Actions
Description:
This function creates entities by pivoting them around a point from one point to another. Use this
function for Parasolid solids.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
STRING pivot_point_1[] This value specifies the pivot point.
STRING pivot_point_2[] This value specifies the point which defines the
beginning of the pivot operation.
STRING pivot_point_3[] This value specifies the pivot which defines the end of
the pivot operation.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be pivoted.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000211 The length of the Axis equals zero.
1000302 The three points specified are nearly collinear.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
860 PCL Reference Manual
Transform Actions
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
One entity will be created for each entity transformed. Each entity created will be displayed in the
graphics window.
Example:
None.
Chapter 3: Geometry Functions 861
Transform Actions
Description:
This function creates entities by translating and rotating a set of entities. Use this function for Parasolid
solids.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be created.
STRING entity_type[] This value specifies the type of entity. This value can be set
to: point, curve, surface, solid, plane, or
vector.
STRING point_1[] This value specifies the first point describing the location
and orientation from which the set of entities will be
transformed.
STRING point_2[] This value specifies the second point describing the
location and orientation from which the set of entities will
be transformed.
STRING point_3[] This value specifies the third point describing the location
and orientation from which the set of entities will be
transformed.
STRING point_4[] This value specifies the first point describing the location
and orientation to which the set of entities will be
transformed.
STRING point_5[] This value specifies the second point describing the
location and orientation to which the set of entities will be
transformed.
STRING point_6[] This value specifies the third point describing the location
and orientation to which the set of entities will be
transformed.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be transformed.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
862 PCL Reference Manual
Transform Actions
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000211 The length of the Axis equals zero.
1000302 The three points specified are nearly collinear.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Chapter 3: Geometry Functions 863
Transform Actions
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
One entity will be created for each entity transformed. Each entity created will be displayed in the
graphics window.
Example:
None.
864 PCL Reference Manual
Transform Actions
Description:
This function creates entities by rotating a set of entities around an axis in a reference coordinate
frame. Use this function for Parasolid solids.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the angle of rotation in degrees.
REAL offset This value specifies the offset angle between the entity
and the beginning of the angle of rotation in degrees.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of times to repeat this
transformation operation on each created entity.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be rotated.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
Chapter 3: Geometry Functions 865
Transform Actions
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
The input value num_repeat specifies the number of entities that will be created for each entity specified
by the input value entity_list. Each entity will be displayed in the graphics window.
Example:
None.
866 PCL Reference Manual
Transform Actions
Description:
This function creates entities by scaling a set of entities. Use this function for Parasolid solids.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
REAL scale(3) This value specifies three scaling values.
STRING origin[] This value specifies the origin for the scaling operation.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of scaling operations to
be done for each point.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be scaled.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
Chapter 3: Geometry Functions 867
Transform Actions
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
The input value num_repeat specifies the number of entities that will be created for each entity specified
by the input value entity_list. Each entity will be displayed in the graphics window.
Example:
None.
868 PCL Reference Manual
Transform Actions
Description:
This function creates solids by simultaneously translating, scaling, rotating, and warping a set of
solids. Use this function for Parasolid solids.
Input:
STRING solid_labels[] This value specifies the labels of the solids to be created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: solid.
STRING coord_frame[] This value specifies the reference coordinate frame.
STRING origin[] This value specifies the origin for the transformation.
STRING translation[] This value specifies a translation vector defining the
direction and distance of a translation operation. This
value will be used only if a translation operation has been
specified with the input value rotation_matrix.
STRING rotation_matrix[](3) This value specifies the translation, scaling, rotation, and
warp operations to be done on the set of solids. See the
remarks below for more information.
LOGICAL delete_original This value is set to TRUE if the original solids are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING solid_list[] This value specifies the list of solids to be transformed.
Output:
STRING created_labels[] This value returns the labels of the solids created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
Chapter 3: Geometry Functions 869
Transform Actions
Remarks:
This function displays the number of solids created and their labels. If the original solids are to be deleted,
the number of solids deleted and their labels will also be displayed.
One solid will be created for each solid transformed. Each solid created will be displayed in the graphics
window.
The input value rotation_matrix can be used to specify a translation operation by placing the value 1
along the positive diagonal of the matrix and defining a vector for the input value translation:
1 1 0 0
2 0 1 0
3 0 0 1
The input value rotation_matrix can be used to specify a scaling operation by placing nonzero values
along the positive diagonal of the matrix. If the input value translation is defined the set of points will be
both translated and scaled:
1 2 0 0
2 0 2 0
3 0 0 2
The input value rotation_matrix can be used to specify a mirroring operation by placing a negative value
along the positive diagonal of the matrix at the position that represents the normal to the mirror plane. A
negative value placed at rotation_matrix(1,1) would represent a mirror plane along the XY axis,
870 PCL Reference Manual
Transform Actions
rotation_matrix(2,2) the YZ axis, and rotations_matrix(3,3) the XZ plane. The example below would
mirror a set of points around the XY plane, scale the points, and if the input value translation is defined,
translate the set of points as well:
1 -3 0 0
2 0 3 0
3 0 0 3
The input value rotation_matrix can be used to specify rotation and warp operations by placing values
that are not along the positive diagonal of the matrix. The example below would cause a rotation
operation only to take place. If the values in the input value rotation_matrix describe a non-orthogonal
matrix the set of point would be warped as a function of position:
1 0 1 1
2 1 0 1
3 1 1 0
Example:
None.
Chapter 3: Geometry Functions 871
Transform Actions
Description:
This function creates entities by translating a set of entities. This function is to be used for Parasolid
solids.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
STRING delta[] This value specifies the translation vector.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of translations for each
entity.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be translated.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is
unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
872 PCL Reference Manual
Transform Actions
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
The input value num_repeat specifies the number of entities that will be created for each entity specified
by the input value entity_list. Each entity will be displayed in the graphics window.
Example:
None.
Chapter 3: Geometry Functions 873
Transform Actions
Description:
This function creates entities by translating a set of entities. This function is to be used for Parasolid
solids.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
STRING delta[] This value specifies the direction vector.
REAL magnitude This value specifies the vector magnitude.
LOGICAL reverse_direction This value is set to TRUE if the direction vector is to be
reversed. If this value is set to FALSE, the direction
vector will not be reversed.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of translations for each
entity.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be translated.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
874 PCL Reference Manual
Transform Actions
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is
unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
The input value num_repeat specifies the number of entities that will be created for each entity specified
by the input value entity_list. Each entity will be displayed in the graphics window.
Example:
None.
Chapter 3: Geometry Functions 875
Transform Actions
Description:
This function creates entities by translating a set of entities from one coordinate frame to a second
coordinate frame. The entities created will have the same parametric locations relative to the new
coordinate frame that they had to the original coordinate frame.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
STRING coord_frame_1[] This value specifies the coordinate frame from which the
set of entities will be translated.
STRING coord_frame_2[] This value specifies the coordinate frame to which the
entities will be translated.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be transformed.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
876 PCL Reference Manual
Transform Actions
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
One entity will be created for each entity transformed. Each entity created will be displayed in the
graphics window.
Example:
Description:
This function will create entities by mirroring a set of entities.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
STRING plane[] This value specifies the mirror plane.
REAL offset This value specifies the offset distance from the mirror
plane.
LOGICAL reverse This value is set to TRUE if the new entities are to be
reversed. If this value is set to FALSE, the entities will
not be reversed.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be mirrored.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is
unclassifiable.
878 PCL Reference Manual
Transform Actions
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
One entity will be created for each entity mirrored. Each entity created will be displayed in the graphics
window.
Example:
Description:
This function creates entities by pivoting them around a point from one point to another.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
STRING pivot_point_1[] This value specifies the pivot point.
STRING pivot_point_2[] This value specifies the point which defines the
beginning of the pivot operation.
STRING pivot_point_3[] This value specifies the pivot which defines the end of
the pivot operation.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be pivoted.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000211 The length of the Axis equals zero.
1000302 The three points specified are nearly collinear.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
880 PCL Reference Manual
Transform Actions
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
One entity will be created for each entity transformed. Each entity created will be displayed in the
graphics window.
Example:
Description:
This function creates points by translating and rotating a set of entities.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
STRING point_1[] This value specifies the first point describing the
location and orientation from which the set of entities
will be transformed.
STRING point_2[] This value specifies the second point describing the
location and orientation from which the set of entities
will be transformed.
STRING point_3[] This value specifies the third point describing the
location and orientation from which the set of entities
will be transformed.
STRING point_4[] This value specifies the first point describing the
location and orientation to which the set of entities will
be transformed.
STRING point_5[] This value specifies the second point describing the
location and orientation to which the set of entities will
be transformed.
STRING point_6[] This value specifies the third point describing the
location and orientation to which the set of entities will
be transformed.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be transformed.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
882 PCL Reference Manual
Transform Actions
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
1000211 The length of the Axis equals zero.
1000302 The three points specified are nearly collinear.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Chapter 3: Geometry Functions 883
Transform Actions
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
One entity will be created for each entity transformed. Each entity created will be displayed in the
graphics window.
Example:
Description:
This function creates entities by rotating a set of entities around an axis in a reference coordinate frame.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
STRING axis[] This value specifies the axis of rotation.
REAL angle This value specifies the angle of rotation in degrees.
REAL offset This value specifies the offset angle between the entity
and the beginning of the angle of rotation in degrees.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of times to repeat this
transformation operation on each created entity.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be rotated.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
Chapter 3: Geometry Functions 885
Transform Actions
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
The input value num_repeat specifies the number of entities that will be created for each entity specified
by the input value entity_list. Each entity will be displayed in the graphics window.
Example:
Description:
This function creates entities by scaling a set of entities.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be
created.
STRING entity_type[] This value specifies the type of entity. This value can be
set to: point, curve, surface, solid, plane, or
vector.
REAL scale(3) This value specifies three scaling values.
STRING origin[] This value specifies the origin for the scaling operation.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of scaling operations to
be done for each point.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be scaled.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is
unclassifiable.
Chapter 3: Geometry Functions 887
Transform Actions
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
The input value num_repeat specifies the number of entities that will be created for each entity specified
by the input value entity_list. Each entity will be displayed in the graphics window.
Example:
Description:
This function creates a parametric tricubic solid by performing vector sums of two existing sets of
solids.
Input:
STRING solid_ids[] This value specifies the solid ID list. If this value is set to an
empty string or to #, the function will automatically
allocate and assign a sequential list of solid IDs.
STRING origin_1[] This value specifies the origin of the vectors for the first set
of solids.
STRING origin_2[] This value specifies the origin of the vectors for the second
set of solids.
REAL scales_1(3) This value specifies the factor to be used to scale the first set
of solid vectors.
REAL scales_2(3) This value specifies the factor to be used to scale the second
set of solid vectors.
STRING solid_list1[] This value specifies the first solid list.
STRING solid_list2[] This value specifies the second solid list.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
1000064 Overwrite of existing entity not permitted.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
Chapter 3: Geometry Functions 889
Transform Actions
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38000452 Unable to calculate a point on the solid.
Remarks:
This function displays a message listing the number of solids created and their IDs.
One solid will be created for each set of solids in the input values solid_list1 and solid_list2. Each solid
created will be displayed in the graphics window.
Example:
Description:
This function creates a parametric bicubic surface by performing vector sums of two existing sets of
surfaces.
Input:
STRING surface_ids[] This value specifies the surface ID list. If this value is set to
an empty string or to #, the function will automatically
allocate and assign a sequential list of surface IDs.
STRING origin_1[] This value specifies the origin of the vectors for the first set
of surfaces.
STRING origin_2[] This value specifies the origin of the vectors for the second
set of surfaces.
REAL scales_1(3) This value specifies the factor to be used to scale the first set
of surface vectors.
REAL scales_2(3) This value specifies the factor to be used to scale the second
set of surface vectors.
STRING surface_list1[] This value specifies the first surface list.
STRING surface_list2[] This value specifies the second surface list.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
1000064 Overwrite of existing entity not permitted.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
Chapter 3: Geometry Functions 891
Transform Actions
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
38000451 Unable to calculate a point on the surface.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
One surface will be created for each set of surfaces in the input values surface_list1 and surface_list2.
Each surface created will be displayed in the graphics window.
Example:
Description:
This function creates entities by translating a set of entities.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be created.
STRING entity_type[] This value specifies the type of entity. This value can be set
to: point, curve, surface, solid, plane, or
vector.
STRING delta[] This value specifies the translation vector.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of translations for each
entity.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be translated.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
Chapter 3: Geometry Functions 893
Transform Actions
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
The input value num_repeat specifies the number of entities that will be created for each entity specified
by the input value entity_list. Each entity will be displayed in the graphics window.
Example:
Description:
This function creates entities by translating a set of entities.
Input:
STRING entity_labels[] This value specifies the labels of the entities to be created.
STRING entity_type[] This value specifies the type of entity. This value can be set
to: point, curve, surface, solid, plane, or
vector.
STRING delta[] This value specifies the direction vector.
REAL magnitude This value specifies the vector magnitude.
LOGICAL reverse_direction This value is set to TRUE if the direction vector will be
reversed. If this value is set to FALSE, the direction vector
will not be reversed.
STRING coord_frame[] This value specifies the reference coordinate frame.
INTEGER num_repeat This value specifies the number of translations for each
entity.
LOGICAL delete_original This value is set to TRUE if the original entities are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING entity_list[] This value specifies the list of entities to be translated.
Output:
STRING created_labels[] This value returns the labels of the entities created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
2011004 The Repeat Count must be greater than 0.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
Chapter 3: Geometry Functions 895
Transform Actions
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38001209 An invalid geometric entity type was used as input. Unable to process request.
Remarks:
This function displays the number of entities created and their labels. If the original entities are to be
deleted, the number of entities deleted and their labels will also be displayed.
The input value num_repeat specifies the number of entities that will be created for each entity specified
by the input value entity_list. Each entity will be displayed in the graphics window.
Example:
Edit Actions
This section is used to describe some of the functions used to implement the Edit actions.
Description:
This function will create parametric cubic curves from a set of curves, enforcing the first derivative
continuity across the boundaries of the curves.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value is set to
an empty string or to #, the function will automatically
allocate and assign a sequential list of curve IDs.
STRING weights[] This value specifies the weighting factors of one curve
relative to another. This value must be greater than zero. A
value of 1.0 will cause all curves to have an equal weight.
A value greater than 1.0 will allow the slope of a curve at
the beginning of the list of curves specified by the input
value curve_list to dominate the slope of the created curves.
A value less than 1.0 will allow the slope of a curve at the
end of the list of curves specified by the input value
curve_list to dominate the slope of the created curves.
STRING curve_list[] This value specifies the list of curves to blend.
LOGICAL delete_original This value is set to TRUE if the original curves are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Chapter 3: Geometry Functions 897
Edit Actions
A curve will be created for each identifier specified by the input value curve_ids. If the input value
curve_ids is set to an empty string or #, a single curve will be created. All curves created will be
displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000574 There must be at least two curves as input to Blend. The invalid value input was %A%.
1000575 Line %I% with vertices %I% and %I% cannot blend with Line %I% with vertices
%I% and %I%.
1000576 One of the curves input to blend has a vector length of zero. Unable to blend curves.
1000587 Unable to merge with a circular curve.
2001070 Unable to acquire %I% words of virtual memory.
38000003 No blob provided.
38000117 An attempt to approximate a general curve with a single Parametric Cubic failed.
38000450 Unable to calculate a point on the curve.
Example:
Description:
This function will create parametric cubic curves from a set of curves by merging the original curves.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value is set to an
empty string or to #, the function will automatically
allocate and assign a sequential list of curve IDs.
STRING curve_list[] This value specifies the list of original curves to merge.
INTEGER num_curves This value specifies the number of curves to create from the
existing set of curves.
REAL geo_tolerance This value specifies the geometric tolerance used to test for
convergence. The default value is 0.005.
INTEGER num_iterations This value specifies the maximum number of times to iterate
during the numerical approximation. The default value is 0.
LOGICAL delete_original This value is set to TRUE if the original curves are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
The input value num_curves specifies the number of curves that will be created. All curves created will
be displayed in the graphics window.
This function can display an information popup message form with the following message:
1000517 The Line Construct parameter %A% was reset from the invalid input value of %I% to
the default value of %I%.
Chapter 3: Geometry Functions 899
Edit Actions
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function will create parametric tricubic solids from a set of solids, enforcing the first derivative
continuity across the boundaries of the solids.
Input:
STRING solid_ids[] This value specifies the solid ID list. If this value is set to an
empty string or to #, the function will automatically
allocate and assign a sequential list of solid IDs.
STRING weights[] This value specifies the weighting factors of one solid
relative to another. This value must be greater than zero. A
value of 1.0 will cause all solids to have an equal weight. A
value greater than 1.0 will allow the slope of a solid at the
beginning of the list of solids specified by the input value
solid_list to dominate the slope of the created solids. A value
less than 1.0 will allow the slope of a solid at the end of the
list of solids specified by the input value solid_list to
dominate the slope of the created solids.
STRING solid_list[] This value specifies the list of solids to blend.
LOGICAL delete_original This value is set to TRUE if the original solids are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
A solid will be created for each identifier specified by the input value solid_ids. If the input value
solid_ids is set to an empty string or #, a single solid will be created. All solids created will be displayed
in the graphics window.
Chapter 3: Geometry Functions 901
Edit Actions
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function will create parametric bicubic surfaces from a set of surfaces, enforcing the first
derivative continuity across the boundaries of the surfaces.
Input:
STRING surface_ids[] This value specifies the surface ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING edge_list[] This value specifies the list of surface edges to be
assigned a weighting factor.
STRING weights[] This value specifies the weighting factors of one surface
relative to another. This value must be greater than zero.
A value of 1.0 will cause all surfaces to have an equal
weight. A value greater than 1.0 will allow the slope of a
surface at the beginning of the list of surfaces specified
by the input value surface_list to dominate the slope of
the created surfaces. A value less than 1.0 will allow the
slope of a surface at the end of the list of surfaces
specified by the input value surface_list to dominate the
slope of the created surfaces.
STRING surface_list[] This value specifies the list of original surfaces to blend.
LOGICAL delete_original This value is set to TRUE if the original surfaces are to
be deleted. If this value is set to FALSE, the original
entities will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
Chapter 3: Geometry Functions 903
Edit Actions
A surface will be created for each identifier specified by the input value surface_ids. If the input value
surface_ids is set to an empty string or #, a single surface will be created. All surfaces created will be
displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function will create hyperpatches from an existing set of hyperpatches, enforcing the first
derivative continuity across the boundaries of the solids.
Input:
STRING hpat_ids[] This value specifies the hyperpatch ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
hyperpatch IDs.
STRING weights[] This value specifies the weighting factors of one
hyperpatch relative to another. This value must be greater
than zero. A value of 1.0 will cause all hyperpatches to
have an equal weight. A value greater than 1.0 will allow
the slope of a hyperpatch at the beginning of the list of
hyperpatches specified by the input value hpat_list to
dominate the slope of the created hyperpatches. A value
less than 1.0 will allow the slope of a hyperpatch at the
end of the list of hyperpatches specified by the input
value hpat_list to dominate the slope of the created
hyperpatches.
STRING hpat_list[] This value specifies the list of hyperpatches to blend.
LOGICAL delete_original This value is set to TRUE if the original hyperpatches are
to be deleted. If this value is set to FALSE, the original
entities will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of hyperpatches created and their IDs.
Chapter 3: Geometry Functions 905
Edit Actions
A hyperpatch will be created for each identifier specified by the input value hypat_ids. If the input value
hypat_ids is set to an empty string or #, a single hyperpatch will be created. All hyperpatches created
will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function will create hyperpatches from an existing set of hyperpatches by breaking the original
hyperpatches at a parametric position, point or node, curve, or surface.
Input:
STRING hpat_ids[] This value specifies the hyperpatch ID list. If this value is set
to an empty string or to #, the function will automatically
allocate and assign a sequential list of hyperpatch IDs.
INTEGER break_type This value specifies the type of entity used to define the
break: 0 = parametric position, 1 = point or node, 2 = curve,
and 3 = surface.
STRING break_entity_list[] This value specifies the list of entities used to define the
break.
REAL param_pos(3) This value specifies the parametric positions that define the
break position if the input value break_type is set to 0.
LOGICAL delete_original This value is set to TRUE if the original hyperpatches are to
be deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING solid_list[] This value specifies the list of hyperpatches to break.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000040 Duplicate %A% was not created at users request.
1000064 Overwrite of existing entity not permitted.
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000909 Unable to break the solid.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000003 LpSublistType: No sublist filter bits are set on invocation.
14000004 LpSublistType: I am being invoked with a NULL list.
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
Chapter 3: Geometry Functions 907
Edit Actions
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable.
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter.
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list.
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined.
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist.
14000014 LpSublistNext: Attempt to proceed past last sublist in current list.
14000015 LpSublistNext: End of current list has been reached.
14000208 LpSublistAttributeGet: Curve evaluator error.
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry.
14000211 LpSublistAttributeGet: Surface evaluator error.
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type.
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL.
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately
approximated to within an order of magnitude of the present geometric tolerance.
38000452 Unable to calculate a point on the solid.
Remarks:
This function displays a message listing the number of hyperpatches created and their IDs.
One hyperpatch will be created for each entry in the input value hpat_list. All hyperpatches created will
be displayed in the graphics window.
Example:
Description:
This function reverses the connectivity and relocates the parametric origin of a set of hyperpatches.
Input:
STRING hpat_list[] This value specifies the list of original hyperpatches to
reverse.
Output:
STRING reversed_labels[] This value returns the reversed ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of hyperpatches reversed and their IDs
Each hyperpatch specified by the input value hpat_list will be reversed. All hyperpatches that have been
reversed will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function will create lines from an existing set of lines, enforcing the first derivative continuity
across the boundaries of the lines.
Input:
STRING line_ids[] This value specifies the line ID list. If this value is set to an
empty string or to #, the function will automatically
allocate and assign a sequential list of line IDs.
STRING weights[] This value specifies the weighting factors of one line
relative to another. This value must be greater than zero. A
value of 1.0 will cause all lines to have an equal weight. A
value greater than 1.0 will allow the slope of a line at the
beginning of the list of lines specified by the input value
line_list to dominate the slope of the created lines. A value
less than 1.0 will allow the slope of a line at the end of the
list of lines specified by the input value line_list to
dominate the slope of the created lines.
STRING line_list[] This value specifies the list of lines to blend.
LOGICAL delete_original This value is set to TRUE if the original lines are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
A line will be created for each identifier specified by the input value line_ids. If the input value line_ids
is set to an empty string or #, a single line will be created. All lines created will be displayed in the
graphics window.
910 PCL Reference Manual
Edit Actions
This function can display a fatal popup message form with the following messages:
1000574 There must be at least two curves as input to Blend. The invalid value input was
%A%.
1000575 Line %I% with vertices %I% and %I% cannot blend with Line %I% with vertices
%I% and %I%.
1000576 One of the curves input to blend has a vector length of zero. Unable to blend curves.
1000587 Unable to merge with a circular curve.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Description:
This function will create lines from an existing set of lines by merging the original lines.
Input:
STRING line_ids[] This value specifies the line ID list. If this value is set to
an empty string or to #, the function will automatically
allocate and assign a sequential list of line IDs.
STRING line_list[] This value specifies the list of original lines to merge.
INTEGER num_lines This value specifies the number of lines to create from the
existing set of lines.
REAL geo_tolerance This value specifies the geometric tolerance used to test
for convergence. The default value is 0.005.
INTEGER num_iterations This value specifies the maximum number of times to
iterate during the numerical approximation. The default
value is 0.
LOGICAL delete_original This value is set to TRUE if the original lines are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of lines created and their IDs.
A line will be created for each line in the input value line_list. All lines created will be displayed in the
graphics window.
This function can display an information popup message form with the following message:
1000517 The Line Construct parameter %A% was reset from the invalid input value of %I%
to the default value of %I%.
912 PCL Reference Manual
Edit Actions
This function can display a fatal popup message form with the following messages:
Example:
Remarks:
This function displays a message listing the number of patches created and their IDs.
A patch will be created for each identifier specified by the input value patch_ids. If the input value
patch_ids is set to an empty string or #, a single patch will be created. All patches created will be
displayed in the graphics window.
914 PCL Reference Manual
Edit Actions
This function can display a fatal popup message form with the following messages:
1000722 There must be at least two surfaces as input to Blend. The invalid value input was
%A%.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Description:
This function will create patches from an existing set of patches by breaking the original patches at a
parametric position, point or node, curve, or surface.
Input:
STRING patch_ids[] This value specifies the patch ID list. If this value is set
to an empty string or to #, the function will
automatically allocate and assign a sequential list of
patch IDs.
INTEGER break_type This value specifies the type of entity used to define the
break: 0 = parametric position, 1 = point or node, 2 =
curve, and 3 = surface.
STRING break_entity_list[] This value specifies the list of entities used to define the
break.
REAL param_pos(2) This value specifies the parametric positions that define
the break position if the input value break_type is set to
0.
LOGICAL delete_original This value is set to TRUE if the original patches are to be
deleted. If this value is set to FALSE, the original entities
will not be deleted.
STRING patch_list[] This value specifies the list of original patches to break.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
1000706 The specified surfaces do not intersect.
1000709 Unable to intersect the curves being used to construct a patch. The curves must form
a closed region and must be in a circular order.
1000713 Unable to break the patch.
1000714 An error occurred while manifolding on a surface.
1000715 Designated point not on the patch.
916 PCL Reference Manual
Edit Actions
Remarks:
This function displays a message listing the number of patches created and their IDs.
One patch will be created for each entry in the input value patch_list. All hyperpatches created will be
displayed in the graphics window.
Example:
Description:
This function will refit Patran solids to a Parasolid representation.
Input:
STRING output_ids[] This value specifies the entityID list. If this value is set to
an empty string or to #, the function will automatically
allocate and assign a sequential list of entity IDs.
REAL refit_tol This value specifies the tolerance to be used to refit the
solid.
LOGICAL delorg This value specifies whether or not to delete the original
Patran solid after the refit.
STRING solid_list[] This value specifies the Patran solids to refit.
Output:
STRING edit_ids[VIRTUAL] This value returns a description of the refit identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output value edit_ids. It is the responsibility of
the calling function to free the allocated string storage space.
This function will update the surface identifiers that are stored in the database and displayed in a
viewport.
Example:
918 PCL Reference Manual
Edit Actions
Description:
This function will create a constant radius edge blend on an edge(s) of a solid
Input:
REAL radius This value specifies the constant radius of the edge
blend
INTEGER entity_type This value specifies the type of the input entities
(1 - Edge, 2 - Face, 3 - Solid).
STRING entity_list[VIRTUAL] This value specifies the list of entities to create the
edge blend.
Output:
STRING created_labels[VIRTUAL] This value returns a description of the created
surface identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
Chapter 3: Geometry Functions 919
Edit Actions
Description:
This function will create a constant angle chamfer type edge blend on an edge(s) of a solid
Input:
REAL first_size This value specifies the size of the chamfer on the
first surface.
REAL angle This value specifies the size of the chamfer on the
other surface.
INTEGER entity_type This value specifies the type of the input entities (1
- Edge, 2 - Face, 3 - Solid).
STRING entity_list[VIRTUAL] This value specifies the list of input entities to
create the chamfer.
Output:
STRING created_labels[VIRTUAL] This value returns a description of the created
surface identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
920 PCL Reference Manual
Edit Actions
Description:
This function will disassemble B-rep Solids into their constituent surfaces.
Input:
STRING solid_list[] This value specifies the B-rep Solids to
disassemble.
LOGICAL convert_surfaces This value specifies whether or not to convert the
constituent surfaces into simply trimmed(green)
surfaces. Green surfaces are used to create
TriParametric Solids(blue).
LOGICAL delorg This value specifies whether or not to delete the
original Patran solid after the disassemble.
Output:
STRING edit_ids[VIRTUAL] This value returns a description of the surface
identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output value edit_ids. It is the responsibility of
the calling function to free the allocated string storage space.
This function will update the surface identifiers that are stored in the database and displayed in a
viewport.
Example:
Chapter 3: Geometry Functions 921
Edit Actions
Description:
This function will imprint the selected solid bodies on solid bodies.
Input:
STRING imprinting_solid[] This value specifies the list of imprinting solids.
STRING imprinted_solid[] The value specifies the target solid bodies for
imprinting.
Output:
STRING edited_labels[VIRTUAL] This value returns a description of the edited solid
identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output value created_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the surface identifiers that are stored in the database and displayed in a
viewport.
Example:
922 PCL Reference Manual
Edit Actions
Description:
This function will refit Solids to TriCubicNet or TriParametric geometric representation. If the solid
is of type B-rep, then it must have only five or six faces.
Input:
STRING output_ids[] This value specifies the entityID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of entity IDs.
INTEGER refit_type This value specifies the type of solid to refit into:
1 = TriCubicNet
2 = TriParametric
INTEGER udensity This value specifies the internal density in the
parametric u direction for the number of tri-cubic
solids to create in the TriCubicNet Solid. (Used if
refit_type = 1)
INTEGER vdensity This value specifies the internal density in the
parametric v direction for the number of tri-cubic
solids to create in the TriCubicNet Solid. (Used if
refit_type = 1)
INTEGER wdensity This value specifies the internal density in the
parametric w direction for the number of tri-cubic
solids to create in the TriCubicNet Solid. (Used if
refit_type = 1)
REAL refit_tol This value specifies the tolerance to be used to refit
the solid. (Used if refit_type = 2)
LOGICAL delorg This value specifies whether or not to delete the
original Patran solid after the refit.
STRING solid_list[] This value specifies the Patran solids to refit.
Output:
STRING edit_ids[VIRTUAL] This value returns a description of the refit
identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Chapter 3: Geometry Functions 923
Edit Actions
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output value edit_ids. It is the responsibility of
the calling function to free the allocated string storage space.
This function will update the surface identifiers that are stored in the database and displayed in a
viewport.
Description:
This function will hollow a solid by shelling the selected faces.
Input:
REAL thickness This value specifies the thickness for shelling.
STRING face_list[VIRTUAL] This value specifies the list of faces to shell.
Output:
STRING created_labels[VIRTUAL] This value returns a description of the created
surafce identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
924 PCL Reference Manual
Edit Actions
Description:
This function will trim an existing surface using one of its edges and optionally remove the remaining
sliver surface.
Input:
STRING surface[] This value specifies the surface to trim.
STRING edge[] This value specifies the edge to use for trimming
the surface.
LOGICAL delete_sliver This value specifies whether or not to delete the
sliver surface remaining after the trim.
Output:
STRING edited_labels[VIRTUAL] This value returns a description of the edited
surface identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output value edited_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the surface identifiers that are stored in the database and displayed in a
viewport.
Example:
Chapter 3: Geometry Functions 925
Edit Actions
Description:
This function breaks solids by planes.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING solid_list[] This value specifies the list of the solids to be
broken.
STRING plane_list[] This value specifies the list of the planes which
will break the solids.
INTEGER delete_orig This value is set to TRUE if the original solids are
to be deleted.
Example:
926 PCL Reference Manual
Edit Actions
Description:
This function breaks a set of solids with a set of planes.
Input:
STRING solid_list[] This value specifies the list of the solids to be
broken.
STRING plane_list[] This value specifies the list of the planes which
will break the solids.
LOGICAL delete_flag This value is set to TRUE if the original solids are
to be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
38001214 Unable to break the solid because failed to break one or more its faces. Slightly
move the splitting plane or surface and break the solid again.
38001217 Unable to break %A%. Errors occurred in breaking its faces. Check the
intersections of the solid faces with the splitting plane/surface. Then check if all
faces, which the plane or surface intersects, can be broken.
Remarks:
This function displays a message listing the number of solids created and their IDs.
Two or more solids will be created. Each solid will be displayed in the graphics window as it is created.
Example:
Description:
This function breaks a set of solids with a set of planes.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING solid_list[] This value specifies the list of the solids to be
broken.
STRING plane_list[] This value specifies the list of the planes which
will break the solids.
LOGICAL delete_orig This value is set to TRUE if the original solids are
to be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
38001214 Unable to break the solid because failed to break one or more its faces. Slightly
move the splitting plane or surface and break the solid again.
38001217 Unable to break %A%. Errors occurred in breaking its faces. Check the
intersections of the solid faces with the splitting plane/surface. Then check if all
faces, which the plane or surface intersects, can be broken.
Example:
928 PCL Reference Manual
Edit Actions
Description:
This function breaks a solid with a surface.
Input:
STRING solid_list[] This value specifies the list of the solids to be
broken.
STRING surface_list[] This value specifies the list of the surfaces which
will break the solids.
LOGICAL delete_flag This value is set to TRUE if the original solids are
to be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
38001214 Unable to break the solid because failed to break one or more its faces. Slightly
move the splitting plane or surface and break the solid again.
38001217 Unable to break %A%. Errors occurred in breaking its faces. Check the
intersections of the solid faces with the splitting plane/surface. Then check if all
faces, which the plane or surface intersects, can be broken.
Remarks:
This function displays a message listing the number of solids created and their IDs.
Two or more solids will be created. Each solid will be displayed in the graphics window as it is created.
Example:
Description:
This function breaks a set of solids with a set of surfaces.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
STRING solid_list[] This value specifies the list of the solids to be
broken.
STRING surface_list[] This value specifies the list of the surfaces which
will break the solids.
LOGICAL delete_orig This value is set to TRUE if the original solids are
to be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
38001214 Unable to break the solid because failed to break one or more its faces. Slightly
move the splitting plane or surface and break the solid again.
38001217 Unable to break %A%. Errors occurred in breaking its faces. Check the
intersections of the solid faces with the splitting plane/surface. Then check if all
faces, which the plane or surface intersects, can be broken.
Example:
930 PCL Reference Manual
Edit Actions
Description:
This function creates curves by breaking a set of curves at an arbitrary intermediate position.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
REAL curve_position This value specifies the parametric position along
the curve of the break point.
STRING curve_list[] This value specifies the list of curves to break.
LOGICAL delete_original This value is set to TRUE if the original curves are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Two curves will be created for each curve to break. All curves created will be displayed in the graphics
window.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
2001070 Unable to acquire %I% words of virtual memory.
Chapter 3: Geometry Functions 931
Edit Actions
Example:
Description:
This function breaks a set of curves with a set of planes.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
STRING plane_list[] This value specifies the list of the planes which will
break the curves.
STRING curve_list[] This value specifies the list of the curves which is to
be broken.
LOGICAL delete_flag This value is set to TRUE if the original curves are
to be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
1000053 No valid geometric entities of type %A% were used as input. Unable to process
request.
38001214 Unable to break the solid because failed to break one or more its faces. Slightly move
the splitting plane or surface and break the solid again.
38001217 Unable to break %A%. Errors occurred in breaking its faces. Check the intersections
of the solid faces with the splitting plane/surface. Then check if all faces, which the
plane or surface intersects, can be broken.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Two or more curves will be created. Each curve will be displayed in the graphics window as it is created.
932 PCL Reference Manual
Edit Actions
Example:
Description:
This function creates a set of curves by breaking a set of curves at a set of points.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING point_list[] This value specifies the list of points on the curve
to specify the break point.
STRING curve_list[] This value specifies the list of curves to break.
LOGICAL delete_original This value is set to TRUE if the original curves are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:.
This function displays a message listing the number of curves created and their IDs.
The number of curves created will be equal to the number of break points + 1 specified by the input value
point_list for each curve to break. All curves created will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function creates curves by disassembling a set of chain curve.
Input:
STRING curve_list[] This value specifies the list of chain curves to
disassemble.
LOGICAL delete_original This value is set to TRUE if the original chains are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Each chain curve will be disassembled into a number of curves based on the geometry of the original
chain. Each curve created will be displayed in the graphics window.
This function can display an information popup message form with the following messages:
This function can display a warning popup message form with the following messages:
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function will create curves by extension of a set of curves by either creating straight curves
which start at the beginning or end of an existing curve and moves in a tangential direction from the
end of the curve for a specified distance or by reparameterizing existing curves starting at the
beginning or end of a curve and continuing for a specified distance.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER extend_type This value specifies the curve type to create from
extending the original curves: 1 = straight curve,
and 2 = continuous curvature curve.
INTEGER length_type This value specifies the curve length type if the
input value extend_type is set to 2: 1= added curve
length, and 2 = percent of total length of original
curve.
REAL curve_length This value specifies the length to extend the curves
STRING curve_extend_point[] This value specifies the original curves to extend
and the points on the curves defining which end of
the curves to extend.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
A curve will be created for each curve to extend. All curves created will be displayed in the graphics
window.
936 PCL Reference Manual
Edit Actions
This function can display a fatal popup message form with the following messages:
1000568 Error evaluating curve for extending. Unable to extend the original curve.
1000569 The curve trying to extend has a tangent of length zero. Unable to extend curve.
1000570 The extended curve length of %G% is invalid. Input length value greater than zero.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Description:
This function will extend curves by starting at the beginning or end of an existing curve and moving
in a tangential direction from the beginning or end of the curve for a specified distance or by
reparameterizing existing curves starting at the beginning or end of a curve and continuing for a
specified distance.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
INTEGER extend_type This value specifies the curve type to create from
extending the original curves: 1 = straight curve,
and 2 = continuous curvature curve.
INTEGER length_type This value specifies the curve length type if the
input value extend_type is set to 2: 1= added curve
length, and 2 = percent of total length of original
curve.
REAL curve_length This value specifies the length to extend the curves
STRING curve_extend_point[] This value specifies the original curves to extend
and the points on the curves defining which end of
the curves to extend.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
All curves created will be displayed in the graphics window.
938 PCL Reference Manual
Edit Actions
This function can display a fatal popup message form with the following messages:
1000568 Error evaluating curve for extending. Unable to extend the original curve.
1000569 The curve trying to extend has a tangent of length zero. Unable to extend curve.
1000570 The extended curve length of %G% is invalid. Input length value greater than zero.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Description:
This function extends two sets of curves to their points of intersection.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING curve1_list[] This value specifies the first curve list to extend to
an intersection point.
STRING curve2_list[] This value specifies the second curve list to extend
to an intersection point.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Pairs of curves from each set of curves will be extended to their points of intersection. All curves will be
displayed in the graphics window.
Chapter 3: Geometry Functions 939
Edit Actions
This function can display a warning popup message form with the following message:
1000559 The intersection point of the pair of curves to extend is within geometric tolerance
( %G% ) of both curves. The original curves were not extended.
This function can display a fatal popup message form with the following messages:
1000555 The two curves are collinear so an intersection point cannot be calculated.
1000556 The two curves are not coplanar so an intersection point cannot be calculated.
1000568 Error evaluating curve for extending. Unable to extend the original curve.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Description:
This function extends a set of curves to their points of intersection.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING curve1_list[] This value specifies the first curve list to extend to
an intersection point.
STRING curve2_list[] This value specifies the second curve list to extend
to an intersection point.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
940 PCL Reference Manual
Edit Actions
This function displays a message listing the number of curves created and their IDs.
Pairs of curves from each set of curves will be extended to their points of intersection. All curves will be
displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000568 Error evaluating curve for extending. Unable to extend the original curve.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Remarks:
Chapter 3: Geometry Functions 941
Edit Actions
This function displays a message listing the number of curves created and their IDs.
Each curve specified will be extended. All curve created will be displayed in the graphics window.
This function can display an information popup message form with the following message:
This function can display a warning popup message form with the following message:
38000439 The selected curve %I% has no center of curvature. The curve can not be
extended into a full circle.
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function extends a set of existing curves by adding extra points at one end of a curve and refitting
the curve to that point.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs (only used if the original curve to
extend is a topological edge).
STRING curve_list[] This value specifies the set of curves to extend.
STRING point_list[] This value specifies the points to add to ends of the
curves being extended.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Each curve listed will be extended. All curves created will be displayed in the graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function will extend a curve to the point of intersection of another curve with an option to break
the intersecting curve at the point of intersection.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING curvepoint_list This value specifies the curve to extend and the end
of the curve to extend from.
STRING curve_list This value specifies the intersecting curve to
extend to.
LOGICAL break This value specifies whether or not to break the
intersecting curve at the point of intersection.
LOGICAL delete_original This value specifies whether or not the original
intersecting curve is to be deleted after the extend
operation.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves edited and their IDs.
All curves edited will be displayed in the graphics window.
944 PCL Reference Manual
Edit Actions
This function can display a fatal popup message form with the following messages:
1000568 Error evaluating curve for extending. Unable to extend the original curve.
1000569 The curve trying to extend has a tangent of length zero. Unable to extend curve.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Description:
This function will create curves by merging a set of curves.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING curve_list[] This value specifies the original curves to merge.
INTEGER num_curves This value specifies the number of curves to create.
REAL merge_tolerance This value specifies the geometric tolerance used
to determine the point distribution along the new
curves and the accuracy of the merge process.
LOGICAL delete_original This value is set to TRUE if the original curves are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Chapter 3: Geometry Functions 945
Edit Actions
The input value num_curves specifies the number of curves that will be created from the input value
curve_list. All curves created will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000500 There must be at least one line as input. The invalid value input was %I%.
38000003 No blob provided.
38000450 Unable to calculate a point on the curve.
38000467 Curves to be chained are not contiguous due to a gap of %G%. The point of
discontinuity has been marked.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Description:
This function will create piecwise cubic spline curves by refitting a set of curves.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of curve IDs.
STRING curve_list[] This value specifies the list of curves to be refitted.
INTEGER refit_method This value specifies the refit method: 1 = tolerance
based, and 2 = num_curves uniformly distributed
cubic spline segments using arc length
parameterization.
REAL refit_tolerance This value specifies the refit tolerance to use if the
input value refit_method is set to 1.
INTEGER num_curves This value specifies the number of spline segments
to create if the input value refit_method is set to 2.
LOGICAL delete_original This value is set to TRUE if the original curves are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of curves created and their IDs.
Curves will be created for each curve in the input value curve_list. Each curve created will be displayed
in the graphics window.
Chapter 3: Geometry Functions 947
Edit Actions
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function will reverse the direction of a set of curves and optionally, any associated finite element
model entities.
Input:
LOGICAL reverse_mesh This value is set to TRUE if any associated finite
element model entities are to be reversed with the
curve. If this value is set to FALSE, any associated
finite element model entities will not be reversed.
STRING curve_list[] This value specifies the list of curves to reverse.
Output:
STRING reversed_ids[] This value returns the reversed ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function trims a set of curves at a defined parametric position, followed by the removal of the
unwanted portion of the original curves.
Input:
REAL curve_position This value specifies the parametric position along
the curve to specify the trim point.
STRING curve_trim_point[] This value specifies the original curve to trim and
the point on the curve defining which end of the
curve to discard.
Output:
STRING trimmed_ids[] This value returns the trimmed ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
Chapter 3: Geometry Functions 949
Edit Actions
1000565 The curve to trim is an edge, and trimming edges is not allowed.
2001070 Unable to acquire %I% words of virtual memory.
Example:
Description:
This function trims a set of curves at defined intersection points, followed by the removal of the
unwanted portion of the original curves.
Input:
STRING trim_point[] This value specifies the point on the curve to
specify the trim point.
STRING curve_trim_point[] This value specifies the original curve to trim and
the point on the curve defining which end of the
curve to discard.
Output:
STRING trimmed_ids[] This value returns the trimmed ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
1000565 The curve to trim is an edge, and trimming edges is not allowed.
2001070 Unable to acquire %I% words of virtual memory.
950 PCL Reference Manual
Edit Actions
Example:
Description:
This function creates a set of solids from an existing set of solids by breaking the original solids at a
parametric position, point or node, curve, or surface.
Input:
STRING solid_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
INTEGER break_type This value specifies the type of entity used to
define the break: 1 = parametric position, 2 = point
or node, 3 = curve, and 4 = surface. Curves,
surfaces and solids will both be approximated to
parametric cubics and then the solid will be
broken.
STRING break_entity_list[] This value specifies the list of entities used to
define the break.
REAL param_pos(3) This value specifies the parametric positions that
define the break position if the input value
break_type is set to 1.
LOGICAL delete_original This value is set to TRUE if the original solids are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
STRING solid_list[] This value specifies the list of original solids to
break.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
952 PCL Reference Manual
Edit Actions
A solid will be created for each solid in the input value solid_list. All solids created will be displayed in
the graphics window.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
2001070 Unable to acquire %I% words of virtual memory.
38000117 An attempt to approximate a general curve with a single Parametric Cubic failed.
38000118 An attempt to approximate a general surface with a single Parametric BiCubic failed.
38000119 An attempt to approximate a general solid with a single Parametric TriCubic failed.
38000121 Invalid format conversion flag specified for surface conversion.
38000122 Invalid format conversion flag specified for solid conversion.
38000434 The solid type used for this Action, Object, Method function is invalid. It must be of
a type that when created, has the default color of Blue.
38000436 Specified Break Method value of %I% is invalid. Valid values are 1-4.
38000452 Unable to calculate a point on the solid.
38000496 Unable to break Solid %I%.
38000497 Unable to break a solid with the specified parametric position values of %G%,
%G%, and %G%.
38000499 Unable to break a solid with the calculated parametric position values of %G%,
%G%, and %G% from the point coordinates of %G%, %G%, and %G%.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Description:
This function creates a set of solids from an existing set of solids by breaking the original solids at a
parametric position, point or node, curve, or surface.
Input:
STRING solid_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to "#", the function will
automatically allocate and assign a sequential list
of solid IDs.
INTEGER break_type This value specifies the type of entity used to
define the break: 1 = parametric position, 2 = point
or node, 3 = curve, and 4 = surface. Curves,
surfaces and solids will both be approximated to
parametric cubics and then the solid will be
broken.
STRING break_entity_list[] This value specifies the list of entities used to
define the break.
REAL param_pos(3) This value specifies the parametric positions that
define the break position if the input value
break_type is set to 1.
LOGICAL delete_original This value is set to TRUE if the original solids are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
STRING solid_list[] This value specifies the list of original solids to
break.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of solids created and their IDs.
954 PCL Reference Manual
Edit Actions
A solid will be created for each solid in the input value solid_list. All solids created will be displayed in
the graphics window.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
2001070 Unable to acquire %I% words of virtual memory.
38000117 An attempt to approximate a general curve with a single Parametric Cubic failed.
38000118 An attempt to approximate a general surface with a single Parametric BiCubic failed.
38000119 An attempt to approximate a general solid with a single Parametric TriCubic failed.
38000121 Invalid format conversion flag specified for surface conversion.
38000122 Invalid format conversion flag specified for solid conversion.
38000434 The solid type used for this Action, Object, Method function is invalid. It must be of
a type that when created, has the default color of Blue.
38000436 Specified Break Method value of %I% is invalid. Valid values are 1-4.
38000452 Unable to calculate a point on the solid.
38000496 Unable to break Solid %I%.
38000497 Unable to break a solid with the specified parametric position values of %G%,
%G%, and %G%.
38000499 Unable to break a solid with the calculated parametric position values of %G%,
%G%, and %G% from the point coordinates of %G%, %G%, and %G%.
38000845 Unable to acquire %I% words of virtual memory.
Example:
None.
Chapter 3: Geometry Functions 955
Edit Actions
Description:
This function disassembles a set of solids into subordinate surface faces.
Input:
STRING solid_list[] This value specifies the solid list.
LOGICAL delete_original This value is set to TRUE if the original solids are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
Output:
STRING created_labels[] This value returns the a list of the labels for the
created entities.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
The number of subordinate faces that each solid will be disassembled into is a function of the geometry
of the original solid. Each surface will be displayed in the graphics window as it is created.
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function will refit a parameterized solid into a tricubic network solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
INTEGER nu This value specifies the number of tricubic solids
to create in the u parametric direction.
INTEGER nv This value specifies the number of tricubic solids
to create in the v parametric direction.
INTEGER nw This value specifies the number of tricubic solids
to create in the w parametric direction.
LOGICAL delete_orig If this value is TRUE, it will delete the original
solid after the refit operation.
STRING solid_list[] This value specifies the solids to refit.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
38000845 Unable to acquire %I% words of virtual memory.
38000434 The solid type used for this Action, Object, Method function is invalid. It must be
of a type that when created, has the default colour of Blue.
38000148 The 3 hyperpatch densities must be positive integers!
Example
Chapter 3: Geometry Functions 957
Edit Actions
Description:
This function will refit a 5 or 6 sided solid into a tricubic network solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
INTEGER nu This value specifies the number of tricubic solids
to create in the u parametric direction.
INTEGER nv This value specifies the number of tricubic solids
to create in the v parametric direction.
INTEGER nw This value specifies the number of tricubic solids
to create in the w parametric direction.
STRING solid_list[] This value specifies the solids to refit.
LOGICAL delete_orig If this value is TRUE, it will delete the original
solid after the refit operation.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
38000845 Unable to acquire %I% words of virtual memory.
38000697 This operation cannot be completed. Please verify that the inputs are valid.
38000698 Solid %I% could not be refit.
38001322 Solid %I% has a face with more than four edges and hence cannot be refit into a
TriParametric Solid.
Example:
958 PCL Reference Manual
Edit Actions
Description:
This function will refit a 5 or 6 sided solid into a tricubic network solid.
Input:
STRING output_ids[] This value specifies the solid ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list
of solid IDs.
REAL tolerance This value specifies the refit tolerance.
LOGICAL solid_type If this value is TRUE, it will create individual
tricubic solids, otherwise, it will create one
triparametric network solid.
LOGICAL delete_orig If this value is TRUE, it will delete the original
solid after the refit operation.
STRING solid_list[] This value specifies the solids to refit.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
38000845 Unable to acquire %I% words of virtual memory.
38000697 This operation cannot be completed. Please verify that the inputs are valid.
38000698 Solid %I% could not be refit.
38001322 Solid %I% has a face with more than four edges and hence cannot be refit into a
TriParametric Solid.
38000652 Solid %I% cannot be refit to within the specified tolerance.
38000653 Solid %I% cannot be refit within a maximum allowable space of 200000 words.
38000654 Solid %I% cannot be refit into less than 1000 hyperpatches for the specified
tolerance.
Example:
Chapter 3: Geometry Functions 959
Edit Actions
Description:
This function will reverse the parameterization of a parameterized solid.
Input:
STRING solid_list[] This value specifies the solids to reverse.
Output:
STRING reversed_ids[] This value returns the reversed ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
38000845 Unable to acquire %I% words of virtual memory.
Example
960 PCL Reference Manual
Edit Actions
Description:
This function will add a hole to a surface by providing either a center point, a center point and a
projection vector, or a closed, chained curve in which to create the hole from.
Input:
INTEGER edit_option This value specifies the option for adding a hole
where:
Error Conditions:
Remarks:
Space is internally allocated for the string returned by the output value edited_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the surface identifiers that are stored in the database and displayed in a
viewport.
Example:
None.
Description:
This function will edit a surface by adding a fillet at a given vertex. The topological effect of this is to
add an edge while eliminating the input vertex.
Input:
REAL radius This value specifies the fillet radius.
STRING point_list[] This value specifies the point list defining the
location to create the fillet.
STRING surface[] This value specifies a single surface to add a fillet to.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
38000845 Unable to acquire %I% words of virtual memory.
38000696 Surface %A% is either a composite trimmed surface or a tessellated surface and, as
such, is not supported by this application.
38000482 This application only works with one surface at a time. Subsequent selected surfaces
will be ignored.
38000672 A fillet of radius %G% could not be added at %A%.
1000572 The fillet curve has a zero radius. The fillet cannot be created.
Example:
962 PCL Reference Manual
Edit Actions
Description:
This function will add a vertex to a surface by providing a list of points to add to the surface.
Input:
STRING point_list[] This value specifies a selection of points to be used
to add vertices to a surface.
STRING surface[] This value specifies a surface to be used to add a
vertex to.
STRING edited_labels[VIRTUAL] This value returns a description of the edited surface
identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
Remarks:
Space is internally allocated for the string returned by the output value edited_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the surface identifiers that are stored in the database and displayed in a
viewport.
Example:
None.
Chapter 3: Geometry Functions 963
Edit Actions
Description:
This function creates a set of surfaces from an existing set of surfaces by breaking the original surfaces
at an isoparametric break, two points on opposing boundaries, or a manifold curve intersecting
opposing boundaries.
Input:
STRING surface_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING surface[] This value specifies the surfaces to break.
LOGICAL delete_original This value is set to TRUE if the original surfaces are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
INTEGER break_method This value specifies the method used to define the
break: 1= isoparametric break, 2= two points on
opposing boundaries, and 3 = manifold curve
intersecting opposing boundaries.
INTEGER iuv This value specifies the iuv value if the input value
break_method is equal to 1: 1 = U held constant, and
2 = V held constant.
REAL uv This value specifies a constant value if the input
value break_method is equal to 1.
STRING point1[] This value specifies the first break point if the input
value break_method is equal to 2.
STRING point2[] This value specifies the second break point if the
input value break_method is equal to 2.
STRING curve[] This value specifies the manifold curve if the input
value break_method is equal to 3.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
964 PCL Reference Manual
Edit Actions
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
A surface will be created for each surface in the input value surface_list. All surfaces created will be
displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
38000404 Unable to break Surface %I%. The Surface to break must be of a type different from
Composite Trimmed Surface.
38000405 Unable to break Surface %I%.
38000428 This application only works with one curve per surface at a time. Please adjust the
input accordingly.
38000429 This application only works with two points per surface at a time. Please adjust the
input accordingly.
38000845 Unable to acquire %I% words of virtual memory.
Example:
Description:
This function creates a set of surfaces from an existing set of surfaces by breaking the original surfaces
at a parametric position, point or node, curve, or surface.
Input:
STRING surface_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING surface_list[] This value specifies the list of original surfaces to
break.
LOGICAL delete_original This value is set to TRUE if the original surfaces are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
INTEGER break_type This value specifies the type of entity used to define
the break: 1 = parametric position, 2 = point or node,
3 = curve, and 4 = surface.
INTEGER iuv This value specifies the iuv value if the input value
break_type is set to 1: 1 = U held constant, and 2 =
V held constant.
REAL uv This value specifies a constant value if the input
value break_type is set to 1.
STRING point1_list[] This value specifies the first break point if the input
value break_type is set to 2.
STRING point2_list[] This value specifies the second break point if the
input value break_type is set to 2.
STRING break_entity_list[] This value specifies the list of curve or surface
entities used to define the break.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
966 PCL Reference Manual
Edit Actions
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
A surface will be created for each surface in the input value surface_list. All surfaces created will be
displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0.
38000404 Unable to break Surface %I%. The Surface to break must be of a type different from
Composite Trimmed Surface.
38000405 Unable to break Surface %I%.
38000428 This application only works with one curve per surface at a time. Please adjust the
input accordingly.
38000429 This application only works with two points per surface at a time. Please adjust the
input accordingly.
38000435 This application only works with one surface per surface at a time. Please adjust the
input accordingly.
38000436 Specified Break Method value of %I% is invalid. Valid values are 1-4.
38000444 The break curve can only intersect the outer boundary of the surface exactly twice.
38000845 Unable to acquire %I% words of virtual memory.
38001221 This functionality is not supported for parasolid surfaces for V6.
Example:
Description:
This function breaks a set of surfaces with a set of planes.
Input:
STRING surface_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING surface_list[] This value specifies the list of the surfaces which are
to be broken.
STRING plane_list[] This value specifies the list of the planes which will
break the surface.
LOGICAL delete_flag This value is set to TRUE if the original surfaces are
to be deleted.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
Two or more surfaces will be created for each surface in the input value surface_list. Each surface will
be displayed in the graphics window as it is created.
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function disassembles a trimmed surface into its parent surface and edge curves.
Input:
STRING surface_list[] This value specifies the trimmed surface list.
LOGICAL delete_original This value is set to TRUE if the original trimmed
surfaces are to be deleted. If this value is set to
FALSE, the original entities will not be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces and curves created and their IDs.
One surface and an N number of curves will be created from each trimmed surface. Each surface and
curve will be displayed in the graphics window as it is created.
This function can display a warning popup message form with the following message:
This function can display a fatal popup message form with the following message:
Example:
Description:
This function disassembles a Trimmed Surface into its constituent entities.
Input:
STRING surface_list[] This value specifies the list of trimmed surfaces to be
disassembled.
LOGICAL delete_original This value is set to TRUE if the original trimmed
surface is to be deleted after it is disassembled.
LOGICAL extract_types This value is set to TRUE if only the parent surface
is to be stored in the database, otherwise both the
parent surface and the edge curves are loaded in the
database after the disassemble.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
1000025 Error attempting to allocate virtual memory.
38000659 %A% is not a General Trimmed Surface.
38000469 Failed to create a spline representation of an edge.
Example:
970 PCL Reference Manual
Edit Actions
Description:
This function will edit a surface by adding some new edges, possibly modifying the existing topology.
Input:
LOGICAL retain_long This value specifies the user preference referring to
the ambiguity present in breaking a loop with a
curve.
Example:
Chapter 3: Geometry Functions 971
Edit Actions
Description:
This function edits surface topology.
Input:
INTEGER edit_option This value specifies the type of edit to perform:
Example:
972 PCL Reference Manual
Edit Actions
Description:
This function will edit a surface by replacing an existing edge with one or more new edges.
Input:
STRING edge[] This value specifies the edge to be replaced (only
one edge will be processed)
STRING curve_list[] This value specifies the curves to be used as
replacement edge(s).
STRING surface[] This value specifies a single surface to replace an
edge from.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
38000845 Unable to acquire %I% words of virtual memory.
38000696 Surface %A% is either a composite trimmed surface or a tessellated surface and, as
such, is not supported by this application.
38000482 This application only works with one surface at a time. Subsequent selected surfaces
will be ignored.
38000673 No edges could be removed. Please check your input.
38000708 This geometric operation has failed for an undetermined reason.
38000700 Edit/edge/replace will only work on one edge at a time. You have selected %I%
curves. Only the first curve will be processed.
38001232 The curves provided for the surface edges are not contiguous due to a gap of %G%.
Either rebuild the curves to eliminate the gap or change the model tolerance to
exceed the gap dimension.
38000702 The replacement curve(s) are not compatible with the selected edge to be replace,
e.g. the selected edge is closed and the replacement curves are not. Please verify that
your inputs are valid for this simple edge replacement.
Example:
Chapter 3: Geometry Functions 973
Edit Actions
Description:
This function will extend a surface to the line of intersection of a point, curve, surface, plane, or extend
two surfaces to their point of intersection. Trimmed Surfaces are not supported.
Input:
STRING surface_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
INTEGER method This value specifies the extend method, where
5 = extend to a plane.
6 = extend to a curve.
7 = extend to a point.
STRING surface[] This value specifies the surface to extend.
STRING edge1[] This value specifies the edge of the surface to start
the extension from.
STRING edge2[] This value specifies the edge of the second surface to
start the extension from. (Used for method=2)
STRING entity[] This value specifies the entity to extend the surface
to, where the entity will be a point, curve, surface, or
plane.
Output:
STRING created_ids[] This value returns the edited ID list.
974 PCL Reference Manual
Edit Actions
Remarks:
This function displays a message listing the number of surfaces created or edited and their IDs.
All surfaces created will be displayed in the graphics window.
This function can display a fatal popup message form with the following messages:
38000687 No intersections found between %A% and %A%. Please try a different extend
option.
38000688 More than one intersection found between %A% and %A%. Please try a different
extend option.
38000689 Unable to extend %A% to %A%. Please try a different extend option.
2001070 Unable to acquire %I% words of virtual memory.
Example:
None.
Chapter 3: Geometry Functions 975
Edit Actions
Description:
This function extends a surface by:
1. Specifying a percentage of the original length to extend in the u-min, u-max, v-min, or v-max
directions.
2. Specifying a fixed length to extend the surface starting at a specified surface edge.
Remarks:
This function displays a message listing the number of surfaces edited and their IDs.
Surfaces will be extended based on the percentage of length input. All surfaces will be displayed in the
graphics window.
This function can display a fatal popup message form with the following messages:
38000690 An attempt to extend %A% beyond the closure limit of 360 degrees is not allowed.
38000691 The value entered is outside the allowed range: [-99 to +100]
2001070 Unable to acquire %I% words of virtual memory.
976 PCL Reference Manual
Edit Actions
Example:
None.
Description:
This function refits a set of surfaces into a nurbs surface or a bicubic surface network.
Input:
STRING curve_ids[] This value specifies the curve ID list. If this value is
set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
curve IDs.
LOGICAL refit_to_nurbs This value is set to TRUE if the surface is to be refit
to nurbs surface, or to FALSE if the surface is to be
refit to bicubic surface network.
REAL refit_tolerance This value specifies the refit tolerance.
LOGICAL delete_original This value is set to TRUE if the original surfaces are
to be deleted. If this value is set to FALSE, the
original entities will not be deleted.
STRING surface_list[] This value specifies the list of surfaces to refit.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays a message listing the number of surfaces created and their IDs.
A surface will be created for each surface in the input value surface_list. Each surface created will be
displayed in the graphics window.
Chapter 3: Geometry Functions 977
Edit Actions
This function can display a warning popup message form with the following messages:
This function can display a fatal popup message form with the following message:
Example:
Description:
This function will edit a Trimmed Surface by removing an edge.
Input:
INTEGER remove_option This value specifies the removal option:
= 1 - User-supplied edges
Example
Chapter 3: Geometry Functions 979
Edit Actions
Description:
This function will remove a hole from a Trimmed Surface by providing an edge curve which represents
a hole in a Trimmed Surface and a Trimmed Surface to remove the hole from.
Input:
STRING curve_list[] This value specifies a selection of edge-curves used
to define the hole in the surface.
STRING trimmed_surface[] This value specifies a single Trimmed Surface used
to define which Trimmed Surface to remove a hole
from.
STRING edited_labels[VIRTUAL] This value returns a description of the edited
Remarks:
Space is internally allocated for the string returned by the output value edited_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the Trimmed Surface identifiers that are stored in the database and displayed
in a viewport.
Example:
None.
980 PCL Reference Manual
Edit Actions
Description:
This function will remove a hole from a Trimmed Surface by providing an edge curve which represents
a hole in a Trimmed Surface and a Trimmed Surface to remove the hole from.
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING curve_list[] This value specifies a selection of edge-curves used
to define the hole in the surface.
STRING trimmed_surface[] This value specifies a single Trimmed Surface to
remove a hole from.
LOGICAL fill_hole This value is set to TRUE if a surface is to be created
to fill the hole, otherwise simply removes the hole.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
38000845 Unable to acquire %I% words of virtual memory.
38000659 No INNER loops or holes were selected from the trimmed surface selected. Try
again.
Example:
Chapter 3: Geometry Functions 981
Edit Actions
Description:
This function will remove a vertex from a Trimmed Surface by providing a list of vertices to remove
from the Trimmed Surface.
Input:
STRING vertex_list[] This value specifies a selection of vertices used to
specify which vertices to remove from the associated
Trimmed Surface(s).
LOGICAL delete_point This value specifies whether or not to delete points
that are associated to the vertex to be removed which
are not volatile to the Trimmed Surface.
STRING edited_labels[VIRTUAL] This value returns a description of the edited surface
identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
Remarks:
Space is internally allocated for the string returned by the output value edited_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the Trimmed Surface identifiers that are stored in the database and displayed
in a viewport.
Example:
None.
982 PCL Reference Manual
Edit Actions
Description:
This function will remove a vertex from a Trimmed Surface by providing a list of vertices to remove
from the Trimmed Surface. If the surface list is blank, ALL surfaces that use the vertices to define
topology will be edited, otherwise, only the specified surfaces will be edited.
Input:
STRING vertex_list[] This value specifies a selection of vertices used to
specify which vertices to remove from the associated
Trimmed Surface(s).
STRING surface_list[] This value specifies a selection of trimmed surfaces
used to specify which trimmed surfaces to remove
vertices from.
LOGICAL delete_point This value specifies whether or not to delete points
that are associated to the vertex to be removed which
are not volatile to the Trimmed Surface.
STRING edited_labels[VIRTUAL] This value returns a description of the edited surface
identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
Remarks:
Space is internally allocated for the string returned by the output value edited_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the Trimmed Surface identifiers that are stored in the database and displayed
in a viewport.
Example:
None.
Chapter 3: Geometry Functions 983
Edit Actions
Description:
This function will remove a vertex from a Trimmed Surface by providing a list of vertices to remove
from the Trimmed Surface. If the surface list is blank, ALL surfaces that use the vertices to define
topology will be edited, otherwise, only the specified surfaces will be edited.
Input:
STRING vertex_list[] This value specifies a selection of vertices used to
specify which vertices to remove from the associated
Trimmed Surface(s).
STRING surface_list[] This value specifies a selection of trimmed surfaces
used to specify which trimmed surfaces to remove
vertices from.
LOGICAL delete_point This value specifies whether or not to delete points
that are associated to the vertex to be removed which
are not volatile to the Trimmed Surface.
STRING edited_labels[VIRTUAL] This value returns a description of the edited surface
identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
Remarks:
Space is internally allocated for the string returned by the output value edited_labels. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the Trimmed Surface identifiers that are stored in the database and displayed
in a viewport.
Example:
None.
984 PCL Reference Manual
Edit Actions
Description:
This function reverses the normal of a set of surfaces and optionally, its associated finite element model
mesh.
Input:
LOGICAL reverse_mesh This value is set to TRUE if the associated finite
element model mesh is to have its normals reversed
with the surface. If this value is set to FALSE, the
finite element model mesh normals will not be
reversed.
STRING surface_list[] This value specifies the list of surfaces to reverse.
Output:
STRING reversed_ids[] This value returns the reversed ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
Example:
Description:
This function will sew surfaces with share common edges to make them topologically congruent.
Input:
STRING surface_list[] This value specifies the surfaces to be sewn together.
Output:
STRING sewed_ids[] This value returns the sewed ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
38000845 Unable to acquire %I% words of virtual memory.
38001501 %A% may not be editable since %A%.
Example
986 PCL Reference Manual
Edit Actions
Description:
This function will sew surfaces with share common edges to make them topologically congruent.
Input:
STRING surface_list[] This value specifies the surfaces to be sewn together.
LOGICAL merge_edges If this value is TRUE, it will to force gap merging,
else FALSE to just break Ts.
LOGICAL premerge_vertices If this value is TRUE, it will equivalence vertices
prior to closing gaps.
LOGICAL sew_nonmanifold If this value is TRUE, it will perform non-manifold
sewing, else FALSE for only manifold sewing.
LOGICAL delete_gap_surfaces If this value is TRUE, it will delete gap surfaces.
Output:
STRING sewed_ids[] This value returns the sewed ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
38000845 Unable to acquire %I% words of virtual memory.
38001501 %A% may not be editable since %A%.
Example
Chapter 3: Geometry Functions 987
Edit Actions
Description:
This function will edit a surface by subtracting surface a from surface b (b-a).
Input:
STRING output_ids[] This value specifies the surface ID list. If this value
is set to an empty string or to #, the function will
automatically allocate and assign a sequential list of
surface IDs.
STRING surface_b[] This value specifies the surface to be subtract from.
STRING surface_a[] This value specifies the surface to subtract from
surface b.
Output:
STRING created_ids[] This value returns the created ID list.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
38000845 Unable to acquire %I% words of virtual memory.
38001232 Edit/surface/subtract has failed. It may be that topology encountered is beyond the
scope of the current implementation. Please try an alternate strategy to achieve the
desired result.
Example
988 PCL Reference Manual
Delete Actions
Delete Actions
This section is used to describe some of the functions used to implement the Delete actions.
Description:
This function deletes a set of coordinate frames from the database and the graphics window.
Input:
STRING coord_list[] This value specifies the labels of the coordinate
frames to be deleted.
Output:
STRING deleted_coords[] This value returns the labels of the coordinate frames
deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of coordinate frames deleted and their labels.
A coordinate frame is deleted for each coordinate frame label in the list provided that the coordinate
frame is not essential for any other entity. The global coordinate frame may not be deleted. Each
coordinate frame deleted is removed from the graphics window.
This function can display an information popup message form with the following message:
This function can display a fatal popup message form with the following message:
Example:
Description:
This function deletes a set of curves from the database and the graphics window.
Input:
STRING curve_list[] This value specifies the labels of the curves to be
deleted.
Output:
STRING deleted_curves[] This value returns the labels of the curves deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of curves deleted and their labels. It also displays the number of curves
not found and their labels.
A curve is deleted for each label in the list provided that the curve is not essential for any other entity.
Each curve deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
38000236 The curve to delete does not exist in the database and may be a geometry
construct. Delete operation not allowed on geometry constructs.
Example:
Description:
This function deletes a set of points from the database and the graphics window.
Input:
STRING point_list[] This value specifies the labels of the points to be
deleted.
Output:
STRING deleted_points[] This value returns the labels of the points deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of points deleted and their labels. It also displays the number of
surfaces not found and their labels.
A point is deleted for each label in the list provided that the point is not essential for any other entity.
Each point deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
38000235 The point to delete does not exist in the database and may be a geometry construct.
Delete operation not allowed on geometry constructs.
Example:
Description:
This function deletes a set of hyperpatches from the database and the graphics window.
Input:
STRING hypat_list[] This value specifies the labels of the hyperpatches to
be deleted.
Output:
STRING deleted_hypats[] This value returns the labels of the solids deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of hyperpatches deleted and their labels. It also displays the number
of hyperpatches not found and their labels.
A hyperpatch is deleted for each label in the list provided that the hyperpatch is not essential for any other
entity. Each hyperpatch deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
38000238 The solid to delete does not exist in the database and may be a geometry construct.
Delete operation not allowed on geometry constructs.
Example:
Description:
This function deletes a set of lines from the database and the graphics window.
Input:
STRING line_list[] This value specifies the labels of the lines to be
deleted.
Output:
STRING deleted_lines[] This value returns the labels of the lines deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of lines deleted and their labels. It also displays the number of lines
not found and their labels.
A line is deleted for each label in the list provided that the line is not essential for any other entity. Each
line deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
38000236 The curve to delete does not exist in the database and may be a geometry construct.
Delete operation not allowed on geometry constructs.
Example:
Description:
This function deletes a set of patches from the database and the graphics window.
Input:
STRING patch_list[] This value specifies the labels of patches to be
deleted.
Output:
STRING deleted_patches[] This value returns the labels of the patches deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of patches deleted and their labels. It also displays the number of
patches not found and their labels.
A patch is deleted for each label in the list provided that the patch is not essential for any other entity.
Each patch deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
38000237 The surface to delete does not exist in the database and may be a geometry
construct. Delete operation not allowed on geometry constructs.
Example:
Description:
This function deletes a set of planes from the database and the graphics window.
Input:
STRING plane_list[] This value specifies the labels of the planes to be
deleted.
Output:
STRING deleted_planes[] This value returns the labels of the planes deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of planes deleted and their labels.
A plane is deleted for each plane label in the list. Each plane deleted is removed from the graphics
window.
This function can display a warning popup message form with the following message:
38000243 The plane to delete does not exist in the database and may be a geometry
construct. Delete operation not allowed on geometry constructs.
Example:
Description:
This function deletes a set of points from the database and the graphics window.
Input:
STRING point_list[] This value specifies the labels of the points to be
deleted.
Output:
STRING deleted_points[] This value returns the labels of the points deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of points deleted and their labels. It also displays the number of
surfaces not found and their labels.
A point deleted for each label in the list provided that the point is not essential for any other entity. Each
point deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
38000235 The point to delete does not exist in the database and may be a geometry construct.
Delete operation not allowed on geometry constructs.
Example:
Description:
This function deletes a set of solids from the database and the graphics window.
Input:
STRING solid_list[] This value specifies the labels of the solids to be
deleted.
Output:
STRING deleted_solids[] This value returns the labels of the solids deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of solids deleted and their labels. It also displays the number of solids
not found and their labels.
A solid is deleted for each label in the list provided that the solid is not essential for any other entity. Each
solid deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
38000238 The solid to delete does not exist in the database and may be a geometry construct.
Delete operation not allowed on geometry constructs.
Example:
Description:
This function deletes a set of surfaces from the database and the graphics window.
Input:
STRING surface_list[] This value specifies the labels of the surfaces to be
deleted.
Output:
STRING deleted_surfaces[] This value returns the labels of the surfaces deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of surfaces deleted and their labels. It also displays the number of
surfaces not found and their labels.
A surface is deleted for each label in the list provided that the surface is not essential for any other entity.
Each surface deleted is removed from the graphics window.
This function can display a warning popup message form with the following message:
38000237 The surface to delete does not exist in the database and may be a geometry construct.
Delete operation not allowed on geometry constructs.
Example:
Description:
This function deletes a set of vectors from the database and the graphics window.
Input:
STRING vector_list[] This value specifies the labels of the vectors to be
deleted.
Output:
STRING deleted_vectors[] This value returns the labels of the vectors deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function displays the number of vectors deleted and their labels.
A vector is deleted for each vector label in the list. Each vector deleted is removed from the graphics
window.
This function can display a warning popup message form with the following message:
38000246 The vector to delete does not exist in the database and may be a geometry construct.
Delete operation not allowed on geometry constructs.
Example:
Utlities
ge_get_midsurface_thickness (p3_label, thickness)
Description:
This function will return the thickness attribute value of a parasolid midsurface.
Input:
INTEGER p3_label This value specifies the external patran surface label
of the midsurface.
Output:
REAL thickness This value returns the value of the thickness attribute
attached to the parasolid midsurface.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
Description:
This function gets the curve length for a curve.
Input:
INTEGER curve_id This values specifies the curve id
Output:
REAL length This value returns the curve length.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
Example:
Chapter 3: Geometry Functions 1001
Utlities
Description:
This function gets the solid volume for a solid.
Input:
INTEGER solid_id This values specifies the solid id
Output:
REAL volume This value returns the solid volume.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
Description:
This function gets the surface area for a surface.
Input:
INTEGER surface_id This values specifies the surface id
Output:
REAL area This value returns the surface area.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
Description:
This function calculates the minimum distance between two curves.
Input:
REAL curve1() This value specifies the data for the first curve.
1002 PCL Reference Manual
Utlities
REAL curve2() This value specifies the data for the second curve.
Output:
REAL distance This value returns the minimum distance between
the two curves.
REAL u1 This value returns the parametric location of the
minimum distance point, relative to the first curve.
REAL u2 This value returns the parametric location of the
minimum distance point, relative to the second
curve.
REAL xyz1(3) This value returns he model space location of the
minimum distance point, relative to the first curve.
REAL xyz2(3) This value returns the model space location of the
minimum distance point, relative to the second
curve.
INTEGER <Return Value> This function can return any value and the value
returned has no meaning.
Error Conditions:
None.
Remarks:
This function returns a value that has no meaning, can have any value, and may change from call to call.
The input values curve1 and curve2 can be any length that is appropriate for the geometric data table that
will be passed to this function.
See the listing for this function in Broken, Obsolete, Modified and New Functions for further information.
Example:
Please see sgm_intersect_curves (p. 33) in the PCL Reference Manual Examples.
Chapter 3: Geometry Functions 1003
Utlities
Description:
This function will find the point on a surface that is nearest to a specified point.
Input:
REAL point(3) This value specifies the model space location of the
point near the surface.
REAL surface() This value specifies the surface.
Output:
REAL u This value returns one coordinate of the parametric
location of the point on the surface nearest to the
specified point.
REAL v This value returns the other coordinate of the
parametric location of the point on the surface
nearest to the specified point.
REAL xyz(4,3) This argument returns the model space location,
derivatives, and normal of the point on the surface
nearest to the specified point.
INTEGER <Return Value> This function can return any value and the value
returned has no meaning.
Error Conditions:
None.
Remarks:
This function returns a value that has no meaning, can have any value, and may change from call to call.
The input value surface can be any length that is appropriate for the geometric data table that will be
passed to this function.
The accuracy of the results of this function are in part dependent on the global model tolerance. This
function uses the global model tolerance to determine when to stop its calculation.
Example:
Please see sgm_nearest_point_on_surface (p. 34) in the PCL Reference Manual Examples.
1004 PCL Reference Manual
Utlities
Chapter 4: Finite Element Functions
PCL Reference Manual
Introduction 1006
Create Action 1008
Transform Action 1062
Sweep Action 1073
Renumber Action 1103
Disassociate Action 1106
Equivalence Action 1108
Optimize Action 1122
Verify Action 1126
Show Action 1192
Modify Action 1196
Delete Action 1237
Utilities 1244
1006 PCL Reference Manual
Introduction
Introduction
This chapter documents the functions that are used in the implementation of the Finite Elements switch
bar form.
This chapter presents function descriptions in ten separate sections:
Create Action This section is used to describe some of the functions used to create
finite element model (FEM) nodes, elements, multi-point constraints
(MPCs), meshes, and mesh seeds.
Transform Action This section is used to describe some of the functions used to mirror,
rotate, and translate finite element model (FEM) nodes, elements,
multi-point constraints (MPCs), meshes, and mesh seeds.
Sweep Action This section is used to describe some of the functions used to
duplicate and/or translate finite element model (FEM) nodes,
elements, multi-point constraints (MPCs), meshes, and mesh seeds
through the use of sweep operations.
Verify Action This section is used to describe some of the functions used to verify
entities in a finite element model (FEM).
Create Action
This section is used to describe some of the functions used to create finite element model (FEM) nodes,
elements, multi-point constraints (MPCs), meshes, and mesh seeds.
fem_conn_fastener_create (id, pname, method, fmt, gs, ga, gb, pata, patb)
Description:
This function will create fastener connectors.
Input:
INTEGER id The starting id for the new connector(s). If zero, then
fetch the next available id from the database.
STRING[] pname[] The connector property name.
STRING[] method The connector creation method (Projection or Axis).
STRING[] fmt The weld format (ELPAT, PARTPAT, ALIGN, ELEMID,
or GRIDID).
STRING[] gs List of connector locations (nodeds or xyz).
STRING[] ga List of surface A pierce nodes.
STRING[] gb List of surface B pierce nodes.
STRING[] pata List of surface A patch identifiers.
STRING[] patb List of surface B patch identifiers.
Output:
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
MSG_FEM_CONN_ZERO_DIAM
MSG_FEM_CONN_GS_OR_GA_REQD
MSG_FEM_CONN_ALIGN_GA_GB_REQD
MSG_FEM_CONN_PATA_PATB_REQD
MSG_FEM_CONN_BAD_POINT_PATCH
MSG_FEM_CONN_GS_NODE_ID_REQD
MSG_FEM_CONN_PROP_NOT_FOUND
Chapter 4: Finite Element Functions 1009
Create Action
Description:
This function will create a fastener connector property record in the database.
Input:
STRING[] name The name of the connector property.
REAL diameter The connector diameter.
REAL(3) kti Stiffness values in directions 1 to 3.
REAL (3) kri Rotation stiffness values in directions 1 to 3.
REAL mass The lumped mass of the fastener.
INTEGER mcid The element stiffness coordinate system (-1 = use
element coordinate system).
INTEGER mflag Defines whether the coordinate system specified for
mcid is absolute (1) or relative (0).
Output:
INTEGER id The ID of the new connector property.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
DbDuplicateEntry
DbMaterialNotFound
Description:
This function will create a connector property record in the database.
Input:
STRING[] name The name of the connector property.
STRING[] type The type of connector property (General, Spot Weld).
STRING[] mat Name of the reference material property.
REAL() rvals Real property values (diameter, Idmin, Idmax, etc.).
INTEGER() ivals Integer property values.
Output:
INTEGER id The ID of the new connector property.
1010 PCL Reference Manual
Create Action
fem_conn_spotweld_create (id, pname, method, fmt, gs, ga, gb, pata, patb,
sptyp)
Description:
This function will create a spot weld connector property record in the database.
Input:
INTEGER id The starting id for the new connector(s). If zero, then
fetch the next available id from the database.
STRING[] pname[] The connector property name.
STRING[] method The connector creation method (Projection or Axis).
STRING[] fmt The weld format (ELPAT, PARTPAT, ALIGN, ELEMID,
or GRIDID).
STRING[] gs List of connector locations (nodeds or xyz).
STRING[] ga List of surface A pierce nodes.
STRING[] gb List of surface B pierce nodes.
STRING[] pata List of surface A patch identifiers.
STRING[] patb List of surface B patch identifiers.
STRING[] sptyp Surface patch types (GRIDID format only).
Q4Q8 = quad4/quad8, Q4T6 = quad4/tri6, etc.
Output:
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
MSG_FEM_CONN_ZERO_DIAM
MSG_FEM_CONN_GS_OR_GA_REQD
MSG_FEM_CONN_ALIGN_GA_GB_REQD
MSG_FEM_CONN_PATA_PATB_REQD
MSG_FEM_CONN_BAD_POINT_PATCH
MSG_FEM_CONN_GS_NODE_ID_REQD
MSG_FEM_CONN_PROP_NOT_FOUND
Chapter 4: Finite Element Functions 1011
Create Action
Description:
This function will create spot weld connectors.
Input:
STRING[] name The name of the connector property.
STRING[] mat Name of the reference material property.
REAL diameter The connector diameter.
INTEGER imset The M-set flag (0=OFF, 1=ON).
Output:
INTEGER id The ID of the new connector property.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
DbDuplicateEntry
DbMaterialNotFound
Description:
This function will create and display new FEM nodes.
Input:
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
STRING anly_coord_frame[] This value specifies an identifier for the analysis
coordinate frame.
INTEGER flag_geometry This value of 1 for the old associated being true and
2 to use the new numbering control scheme.
STRING node_select[] This value specifies a selection of node identifiers to
be used for the FEM nodes being created.
STRING point_select[] This value specifies a selection of points defining
the locations of the FEM nodes to be created.
Output:
STRING fem_nodes_created[VIRTUAL] This value returns a description of the FEM nodes
created.
1012 PCL Reference Manual
Create Action
Remarks:
Space is internally allocated for the string returned by the output value fem_nodes_created. It is the
responsibility of the calling function to free the allocated string storage space.
Example:
Description:
This function will create and display new elements.
Input:
STRING shape[] This value specifies the shape of the elements to be
created. Currently, this value is not used.
STRING element_type[31] This value specifies the element type to be created. See
the remarks below.
STRING element_select[] This value specifies a selection of element identifiers to
be used for the elements being created.
STRING connection_pattern[31] This value specifies the type of connection made between
elements. This case sensitive value may be defined as
Elem Edge, Elem Face, PWL, and Standard.
Setting this argument to any other value will cause the
default or Standard behavior to be used.
INTEGER flag This value of 1 for the old midnode_flag being true and 2
to use the new numbering control scheme.
STRING corner1_node_select[] This value specifies a selection of entities used to define
the nodes for the first corner of the elements being
created.
Chapter 4: Finite Element Functions 1013
Create Action
Remarks:
Point Tet14
Bar2 Tet15
Bar3 Tet16
1014 PCL Reference Manual
Create Action
Bar4 Tet40
Tria3 Wedge6
Tria4 Wedge7
Tria6 Wedge15
Tria7 Wedge16
Tria9 Wedge20
Tria13 Wedge21
Quad4 Wedge24
Quad5 Wedge52
Quad8 Hex8
Quad9 Hex9
Quad12 Hex20
Quad16 Hex21
Tet4 Hex26
Tet5 Hex27
Tet10 Hex32
Tet11 Hex64
Example:
Description:
This function will create and display a cyclic symmetry nodal MPC.
Input:
INTEGER mpc_id This value specifies the ID value to be used to identify the
created MPC.
REAL tolerance This value specifies the tolerance used when comparing
the coordinates of the FEM nodes in the dependent and
independent regions. This argument must have a positive,
nonzero value.
STRING cyl_coord_frame[] This value specifies the cylindrical coordinate frame
whose z axis is the axis of symmetry.
STRING dependent_region[] This value specifies a selection of entities that defines the
dependent region. Entities in this region can be nodes, 3D
element faces, 2D element edges, points, curves, or
surfaces.
STRING independent_region[] This value specifies a selection of entities that defines the
independent region. Entities in this region can be nodes,
3D element faces, 2D element edges, points, curves, or
surfaces.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function will match finite element nodes associated to the entities in the dependent region to the
finite element nodes associated to the entities in the independent region by first mapping them into the
cylindrical coordinate system specified by the input value cyl_coord_frame.
The r and z coordinates of the two sets of finite element nodes will then be compared to determine a
match. An MPC will be created that will tie every degree of freedom from a dependent finite element
node to its matching independent finite element node. The analysis coordinate frame of the matched finite
element nodes will be translated to the cylindrical coordinate frame specified by the input value
cyl_coord_frame with the exception of any finite element nodes that lie on the axis of symmetry.
1016 PCL Reference Manual
Create Action
For the finite element nodes that lie on the axis of symmetry, a rectangular coordinate frame whose z axis
lies on the axis of symmetry will be created and assigned as the analysis coordinate frame.
This function can display an information popup form indicating that the MPC and possibly a coordinate
frame has been created.
Example:
None.
Chapter 4: Finite Element Functions 1017
Create Action
Description:
This function will create and display an MPC which has an association with a selection of specified
FEM nodes.
Input:
INTEGER mpc_id This value specifies the ID value to be used to
identify the created MPC.
STRING mpc_type[31] This value specifies the type of the MPC that
will be created.
REAL constant This value specifies the constant term used with
an MPC of the Explicit type.
INTEGER num_terms This value specifies the number of terms in the
MPC.
LOGICAL dependency_state(num_terms) This value specifies the dependency state for
each term in the MPC where setting an offset to
TRUE indicates that the term is dependent and
setting an offset to FALSE indicates that the
term is independent.
REAL term_coefficients(num_terms) This value specifies the coefficients for each
term in the MPC.
STRING node_select[](num_terms) This value specifies the identifiers for the nodes
used for each term in the MPC.
STRING freedom_select[](num_terms) This value specifies the degrees of freedom for
each term in the MPC.
Output:
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-1 This is an internal status condition. There is no corresponding status message in the
message database.
1 This is an internal status condition. There is no corresponding status message in the
message database.
1018 PCL Reference Manual
Create Action
Remarks:
This function will display an information popup form indicating that the MPC has been created.
Example:
Description:
This function will create and display an MPC which has an association with a selection of specified
FEM nodes.
Input:
INTEGER mpc_id This value specifies the ID value to be used to
identify the created MPC.
STRING mpc_type[32] This value specifies the type of the MPC that
will be created.
REAL constant This value specifies the constant term used with
an MPC of the Explicit type.
INTEGER num_terms This value specifies the number of terms in the
MPC.
LOGICAL dependency_state(num_terms) This value specifies the dependency state for
each term in the MPC where setting an offset to
TRUE indicates that the term is dependent and
setting an offset to FALSE indicates that the
term is independent.
STRING term_coefficients(num_terms) This value specifies the coefficients for each
term in the MPC.
STRING node_select[](num_terms) This value specifies the identifiers for the nodes
used for each term in the MPC.
STRING freedom_select[](num_terms) This value specifies the degrees of freedom for
each term in the MPC.
Output:
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-1 This is an internal status condition. There is no corresponding status message in the
message database.
1 This is an internal status condition. There is no corresponding status message in the
message database.
1020 PCL Reference Manual
Create Action
Remarks:
This function will display an information popup form indicating that the MPC has been created.
Example:
None.
Description:
This function will create and display a sliding surface nodal MPC.
Input:
INTEGER mpc_id This value specifies the ID value to be used to identify the
created MPC.
REAL tolerance This value specifies the tolerance used when comparing
the coordinates of the FEM nodes in the dependent and
independent regions. This argument must have a positive,
nonzero value.
STRING coord_option[31] This value specifies that a coordinate system is to be user
specified or internally created. This argument accepts
User Specified and Automatic as the only valid
setting.
STRING coord_frame[] This value specifies the normal coordinate frame. This
argument is used only when the input value coord_option
is set to User Specified.
STRING normal_axis[31] This value specifies the axis that is normal to every FEM
node. This argument accepts Axis 1, Axis 2, and
Axis 3 as the only valid settings. This argument is used
only when the input value coord_option is set to User
Specified.
STRING dependent_region[] This value specifies a selection of entities that defines the
dependent region. Entities in this region can be 2D
element edges, 2D elements, 3D element faces, 3D surface
edges, and 3D surfaces.
STRING independent_region[] This value specifies a selection of entities that defines the
independent region. Entities in this region can be 2D
element edges, 2D elements, 3D element faces, 3D surface
edges, and 3D surfaces.
Chapter 4: Finite Element Functions 1021
Create Action
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function will match finite element nodes associated to the entities in the dependent region to the
finite element nodes in the independent region. This match is made by comparing the x, y, and z
coordinates of the finite element nodes in the two regions.
The MPC will match the degree of freedom that is normal to the surface of a finite element node in the
dependent region to its matching finite element node in the independent region.
The normal degree of freedom can be supplied by the calling function by setting the input value
coord_option to User Specified, setting the input value coord_frame in an appropriate manner, and
defining the normal axis of the supplied coordinate system by setting the input value normal_axis. The
normal degree of freedom can also be internally calculated by setting the input value coord_option to
Automatic. The normal degree of freedom will then be calculated by creating a coordinate frame for
every node with the z axis set to be normal to the surface of the node. The degrees of freedom along the
z axis of the computed coordinate frame will then be used in matching the finite element nodes in the
dependent and independent regions.
This function can display an information popup indicating that the MPC and possible a coordinate frame
has been created.
Example:
Description:
This function will create a FEM surface mesh between two curves using an isometric meshing
operation.
Input:
STRING curve1_select[] This value specifies a selection of entities that
defines the first set of curves.
STRING curve2_select[] This value specifies a selection of entities that
defines the second set of curves.
INTEGER size_method This value specifies the method used to determine
the size of the mesh. Setting this value to 1 will
allow the function to use the input values
num_along_curve and num_across_curve. Setting
this value to anything other than 1 will allow the
input value global_edge_length to be used.
INTEGER flag This value to use new numbering control scheme.
REAL global_edge_length This value specifies the global element edge length
used in creating the mesh.
INTEGER num_along_curve This value specifies the number of mesh elements
created along the curves defining the area where
the mesh will be placed.
INTEGER num_across_curve This value specifies the number of elements
created across the curves defining the area where
the mesh will be placed.
STRING element_topology[31] This value specifies the topology of the element to
be created. See the remarks below.
STRING node_select[] This value specifies an optional selection of node
identifiers.
STRING element_select[] This value specifies an optional selection of
element identifiers.
STRING anly_coord_frame[] This value specifies an identifier for the analysis
coordinate frame.
Chapter 4: Finite Element Functions 1023
Create Action
Remarks:
Quad4 Tria3
Quad5 Tria4
Quad8 Tria6
Quad9 Tria7
Quad12 Tria9
Quad16 Tria13
Example:
Description:
This function will create a FEM curve mesh using an isometric meshing operation.
Input:
STRING curve_select[] This value specifies a selection of curves to be
meshed.
INTEGER flag This value to use new numbering control scheme.
REAL global_edge_length This value specifies the global element edge length to
be used for the mesh. This value must be greater than
0.
STRING element_topology[31] This value specifies the topology of the elements to
be created and can be set to Bar2, Bar3, and
Bar4 only.
STRING node_select[] This value specifies an optional selection of FEM
node identifiers.
STRING element_select[] This value specifies an optional selection of element
identifiers.
STRING anly_coord_frame[] This value specifies an identifier for the analysis
coordinate frame.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
Output:
INTEGER num_fem_nodes This value returns the number of FEM nodes created
by this function.
INTEGER num_fem_elements This value returns the number of elements created by
this function.
STRING fem_nodes_created This value returns a description of the FEM nodes
[VIRTUAL] created.
STRING fem_elements_created This value returns a description of the elements
[VIRTUAL] created.
Chapter 4: Finite Element Functions 1025
Create Action
Remarks:
Space is internally allocated for the string returned by the output values fem_nodes_created and
fem_elements_created. It is the responsibility of the calling function to free the allocated string storage
space.
Example:
Description:
This function will create a FEM solid mesh.
Input:
STRING mesher[31] This value specifies the type of mesher to be used
to create the FEM mesh and can be set to either
IsoMesh or TetHybrid.
INTEGER options_control This value specifies the use of various options
influencing the creation of the FEM mesh.
STRING solid_select[] This value specifies a selection of solids to be
meshed.
INTEGER num_values This value specifies the number of entries in the
input value value_array.
REAL value_array(num_values) Values used by the meshers.
STRING element_topology[31] This value specifies the topology of the elements to
be created. See the remarks below.
STRING node_select[] This value specifies an optional selection of FEM
node identifiers.
STRING element_select[] This value specifies an optional selection of
element identifiers.
STRING anly_coord_frame[] This value specifies an identifier for the analysis
coordinate frame.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
1026 PCL Reference Manual
Create Action
Output:
INTEGER num_fem_nodes This value returns the number of FEM nodes
created by this function.
INTEGER num_fem_elements This value returns the number of elements created
by this function.
STRING fem_nodes_created This value returns a description of the FEM nodes
[VIRTUAL] created.
STRING fem_elements_created This value returns a description of the elements
[VIRTUAL] created.
Remarks:
Space is internally allocated for the string returned by the output values fem_nodes_created and
fem_elements_created. It is the responsibility of the calling function to free the allocated string storage
space.
The input value element_topology can have the following values:
Tet4 Wedge20
Tet5 Wedge21
Tet10 Wedge24
Tet11 Wedge52
Tet14 Hex8
Tet15 Hex9
Tet16 Hex20
Tet40 Hex21
Wedge6 Hex26
Wedge7 Hex27
Wedge15 Hex32
Wedge16 Hex64
Example:
Description:
This function will call the appropriate solid mesher.
Input:
STRING solid_list[] List of solids to be meshed. Ex: Solid 1:3
STRING mesher_pick[] Mesher to be used: IsoMesh, TetState, TetAries or
TetHybrid (same mesher, different names), or HexMesh.
STRING elem_topo[] Element topology (i.e. Tet4, Tet10, Tet16).
INTEGER mesher_val_qtt Number of values in ac_mesher_val().
STRING ac_mesher_val[] Note that NUMVAL=4
(1:NUMVAL)
(1) : Global Edge Length
(4) : 0.0
1028 PCL Reference Manual
Create Action
+= 16384
(FEM_MF_USE_NEW_NUMBERING_CONTROL_F)
+= 512 (FEM_MF_ALLOW_TRIS_IN_QUAD_MESH_F)
STRING FMF_solid_neigh For force-matched solid faces, this is a list of neighboring solids
bors[] for which we will attempt to match existing meshed faces.
Matching faces are determined by a proximity tolerance
(FMF_prox_tol) on geometric vertices and edge midpoints. Ex:
Solid 4:5
STRING node_list[] List of output node IDs. Ex: Node 1:100
STRING elem_list[] List of output element IDs. Ex: Elm 1:100
STRING a_coord_frame[] Analysis coordinate frame. Ex: Coord 0
STRING r_coord_frame[] Reference coordinate frame. Ex: Coord 0
Output:
INTEGER num_nodes Number of nodes created.
INTEGER num_elems Number of elements created.
STRING nodes_created [] IDs of nodes created. Ex: Node 1:100
Remarks:
Space is internally allocated for the string returned by the output values nodes_created and
elems_created. It is the responsibility of the calling function to free the allocated string storage space.
The input value elem_topo can have the following values:
Tet4 Wedge20
Tet5 Wedge21
Tet10 Wedge24
Tet11 Wedge52
Tet14 Hex8
Tet15 Hex9
Tet16 Hex20
Tet40 Hex21
Wedge6 Hex26
1030 PCL Reference Manual
Create Action
Wedge7 Hex27
Wedge15 Hex32
Wedge16 Hex64
Example:
Description:
This function will create a FEM surface mesh.
Input:
STRING mesher[31] This value specifies the type of mesher to be used
to create the FEM mesh and can be set to either
IsoMesh or Paver.
INTEGER options_control This value specifies the use of various options
influencing the creation of the FEM mesh. See the
remarks below. Multiple options can be set by
adding together the values for the different options.
For example: setting this input value to 9748
would turn on all of the options.
STRING surface_select[] This value specifies a selection of surfaces to be
meshed.
INTEGER num_values This value specifies the number of entries in the
input value value_array. This value should be set to
1 if the input value mesher is set to IsoMesh and
4 if the input value mesher is set to Paver.
Chapter 4: Finite Element Functions 1031
Create Action
STRING value_array(num_values)[] This value specifies the global edge length in offset
1, the allowable curvature error for the curvature
check in offset 2, the minimum desired edge length
for the mesh in offset 3, and the maximum desired
edge length for the mesh in offset four. The global
edge length must be greater than 0.0. The
allowable curvature error can range from 0.0 to
0.25. The desired edge length values must both be
greater than zero and the maximum value must be
greater than the minimum value. Offset 1 is used
only when the input value mesheris set to
IsoMesh and the offsets 2, 3, and 4 are used only
when the input value mesher is set to Paver.
STRING element_topology[31] This value specifies the topology of the elements to
be created. See the remarks below.
STRING node_select[] This value specifies an optional list of FEM nodes.
STRING element_select[] This value specifies an optional list of elements.
STRING anly_coord_frame[] This value specifies an identifier for the analysis
coordinate frame.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
Output:
INTEGER num_fem_nodes This value returns the number of FEM nodes
created by this function.
INTEGER num_fem_elements This value returns the number of elements created
by this function.
STRING fem_nodes_created This value returns a description of the FEM nodes
[VIRTUAL] created.
STRING fem_elements_created This value returns a description of the elements
[VIRTUAL] created.
Remarks:
Space is internally allocated for the string returned by the output values fem_nodes_created and
fem_elements_created. It is the responsibility of the calling function to free the allocated string storage
space.
1032 PCL Reference Manual
Create Action
The integer input value options_control can have the following values:
The string input array value_array can have the following values:
0 Global Length
1 Maximum Deviation
2 Minimum Length
3 Maximum Length
Example:
Description:
This function will deal with the various meanings of the val_array data.
Input:
STRING mesher_pick[] Mesher to be used: IsoMesh or Paver.
INTEGER flag Flag word, not used yet.
0 Global Length
1 Maximum Deviation
2 Minimum Length
3 Maximum Length
STRING elem_topo[] Element topology (i.e.; Quad4).
STRING node_list[] List of output node IDs.
STRING elem_list[] List of output element IDs.
1034 PCL Reference Manual
Create Action
Remarks:
Space is internally allocated for the string returned by the output values nodes_created and
elems_created. It is the responsibility of the calling function to free the allocated string storage space.
The input value elem_topo can have the following values:
Example:
Description:
These functions will convert an input shell mesh to a quad/tria mesh.
Input:
STRING in_elem_list A list of element ids ( "ELEM2D" ). If the "Guide
elements" integer parameter ( offset 16 )
= 0 these are the elements on the input mesh.
= 1 these are the guiding elements for the elements ids to
be obtained from groups.
STRING bndy_vert_list A list of 4 or less node ids defining the boundary verticies
used for iso-meshing. See the "Use iso-meshing" ( offset 3
) integer parameter.
STRING bndy_edge_list A list of bar element ids defining input boundary edges.
STRING bndy_seed_list A list of node ids defining boundary seeds. These
boundary seeds may or may not be on the input mesh
defined for in_elem_list. See the "Seed type" integer
parameter ( offset 1 ).
STRING hard_node_list A list of node ids for defining hard nodes. The nodes may
or may not be on the input mesh and or the boundary of the
input mesh.
STRING hard_edge_list A list of bar element ids defining hard edges. The end
nodes of the hard edges may or may not be on the input
mesh and or the boundary of the of the input mesh.
STRING soft_edge_list A list of bar element ids defining soft edges. The end
nodes of the soft edges may or may not be on the input
mesh and or the boundary of the of the input mesh.
STRING file_name The input data file name.
STRING user_node_id_list A list of output node ids defined by the user.
STRING user_elem_id_list A list of output element ids defined by the user.
STRING elem_type The output element type. Currently only "Quad4" and
"Tria3" are supported.
1036 PCL Reference Manual
Create Action
Remarks:
Description:
This function creates a surface mesh control that will be used to mesh the interior of the surface. The
mesh length given in the Create-Mesh form will continue to drive the element edge lengths on the
boundary of the surfaces selected for meshing, irrespective of the mesh control applied to the
surfaces.
Input:
STRING surface_list[VIRTUAL] This value specifies the list of surfaces to which
surface mesh control must be applied.
STRING global_edge_length Global element length for the surfaces in
surface_list
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Description:
This function creates a surface mesh control that will be used to mesh the interior of the surface. The
mesh length given in the Create-Mesh form will continue to drive the element edge lengths on the
boundary of the surfaces selected for meshing, irrespective of the mesh control applied to the surfaces.
Input:
STRING surface_list[VIRTUAL] This value specifies the list of surfaces to which
surface mesh control must be applied.
INTEGER num_int_arg This value specifies the number of arguments in
the input array int_arg_list.
1042 PCL Reference Manual
Create Action
Example:
Description:
This function creates a new quad/tria mesh over an input mesh according to given mesh parameters.
Input:
STRING domain[] List of shell elements to mesh
over.
STRING node_vertx_list[] Node list for boundary vertices used for iso meshing. Maximal
number of vertices on the list is 4.
STRING bar_bndy_list[] Bar element list for input boundary edges
STRING node_seed_list[] Node list for boundary seeds. If a boundary seed is not a node
on the input mesh, the program will project it onto the mesh.
STRING node_hard_list[] Node list for hard nodes. The program will preserve the hard
nodes on the output mesh. If a hard node is not a node on the
input mesh, the program will project it onto the mesh.
STRING bar_hard_list[] Bar element list for hard element edges. The program will
preserve the hard edges (or its projection) on the output mesh. If
a hard edge is not an existing edge on the input mesh, the
program will project its end nodes onto the mesh and imprint the
edge on the mesh.
STRING bar_soft_list[] Bar element list for soft element edges. A soft feature line is a
sequence of consecutive soft element edges. The program will
preserve the soft feature line and its two end nodes on the output
mesh, but the end nodes of each soft element edge may not be
preserved on the output mesh. If a soft edge is not an existing
edge on the input mesh, the program will imprint the edge on the
mesh.
STRING output_file[] Not used.
STRING node_list[] Node id list specified by user to be assigned to the nodes on
output mesh.
STRING elem_list[] Element id list specified by user to be assigned to the elements
on output mesh.
STRING element_topology[] String for element type. Currently we support "Quad4" and
"Tria3".
REAL edge_length_global Mesh size to be used to create the new mesh.
1044 PCL Reference Manual
Create Action
Description:
This function will create a shell mesh on a congruent surfaced model and preserve the feature curves
and feature vertices on the output mesh.
Input:
STRING surf_list The list of surface to be meshed.
STRING feature_curve_list The list of curves to be preserved.
1046 PCL Reference Manual
Create Action
Offset Description
1 Element size
2 Height/Length ratio
3 "Minimum size"/"Element Size" ratio
4 Maximum size
5 Feature edge angle
6 Feature vertex angle
STRING elem_topo Element topology: "Quad" or "Tria"
STRING node_list List of output node IDs.
STRING elem_list List of output element IDs.
Output:
INTEGER num_nodes The number of nodes created.
INTEGER num_elems The number of elements created.
STRING nodes_created The ids of nodes created.
STRING elems_created The ids of elements created.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Chapter 4: Finite Element Functions 1047
Create Action
Description:
This function will project FEM nodes onto surfaces using the closest approach method.
Input:
STRING node_select[] This value specifies a selection of FEM nodes to be
projected onto the surfaces.
STRING surface_select[] This value specifies a selection of surfaces on which
the FEM nodes will be projected.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function will create FEM points on surfaces using the closest approach method. This method works
by placing a point at the intersection of a vector through a point from the input value node_select with a
surface from the input value surface_select. The vector is created so that it is normal to the surface at its
point of intersection with the surface.
Example:
Description:
This function will project FEM nodes onto surfaces using one of three possible methods.
Input:
STRING node_select[] This value specifies a selection of FEM nodes to be
projected onto the surfaces.
STRING surface_select[] This value specifies a selection of surfaces on
which the FEM nodes will be projected.
INTEGER projection_option This value specifies the method to be used in
projecting the FEM nodes onto the surfaces: 1 =
the closest approach method, 2 = use a vector
projection method, and 3 = the view vector
method.
STRING projection_vector[] This value specifies the projection vector used
when the input value projection_option is set to 2.
STRING coord_frame[] This value specifies the coordinate frame used with
the input value projection_vector. This value is
only used when the input value projection_option
is set to 2.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function will create finite element points on surfaces using one of three methods. The closest
approach method will place a point at the intersection of a vector through a point from the input value
node_select with a surface from the input value surface_select. The vector is created so that it is normal
to the surface at its point of intersection with the surface.
The second method, the vector projection method, will use the input value projection_vector to define a
vector through a point from the input value node_select. This will allow a node point to be created at the
point where the vector intersects a surface specified by the input value surface_select.
The third, or view vector method, is very much like the vector projection method except that the view
vector is used instead of the input value projection_vector.
Chapter 4: Finite Element Functions 1049
Create Action
Example:
Description:
This function will project FEM nodes onto curves using the closest approach method.
Input:
STRING node_select[] This value specifies a selection of FEM nodes to be projected
onto the curves.
STRING curve_select[] This value specifies a selection of curves onto which the FEM
nodes will be projected.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function will create FEM points on curves using the closest approach method. This method works
by placing a point at the intersection of a vector through a point from the input value node_select with a
curve from the input value curve_select. The vector is created so that it is normal to the surface of the
curve at its point of intersection with the curve.
Example:
Description:
This function will project FEM nodes onto a constant plane.
Input:
STRING node_select[] This value specifies a selection of FEM nodes to be
projected onto the plane.
INTEGER direction This value specifies the direction of a vector used to
project the nodes onto the plane and is normal to that
plane. This value can be set to 1= X axis, 2 = Y axis, or 3
= Z axis.
REAL constant_value This value specifies the distance from the origin along the
axis specified by the input value direction at which the
constant plane is defined.
STRING coord_frame[] This value specifies the coordinate frame for the input
value node_select and the constant plane.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Example:
Description:
This function will create and display FEM mesh seeds on a selection of curves based on a uniform, a
one-way bias, or a two-way bias mesh seed spacing.
Input:
STRING curve_select[] This value specifies a selection of curves to be seeded.
INTEGER seed_option This value specifies the options for this function. See the
remarks below.
INTEGER num_seeds This value specifies the number of seeds per edge for use
when the input value seed_option is set to 1, 3, or 5.
REAL ratio This value specifies the length ratio used when the input value
seed_option is set to 3 or 5. This value must be greater than 0.
REAL length_1 This value specifies the first element length used when the
input value seed_option is set to 2, 4, or 6. This value must be
greater than 0.
REAL length_2 This value specifies the second element length used when the
input value seed_option is set to 4 or 6. This value must be
greater than the input value length_1.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The integer input value seed_option can have the following values:
Value Description
1 Space the mesh seeds in a uniform manner using the input value num_seeds to
define the number of mesh seeds per edge.
2 Space the mesh seeds in a uniform manner using the input value length_1 to define
the distance between the mesh seeds.
3 Space the mesh seeds using a one way bias defined by the input values length_1
and ratio.
4 Space the mesh seeds using a one way bias defined by the input value length_2
divided by the input value length_1.
1052 PCL Reference Manual
Create Action
5 Space the mesh seeds using a two way bias defined by the input value num_seeds
and ratio.
6 Space the mesh seeds using a two way bias defined by the input value length_2
divided by the input value length_1.
Placing a one way bias on the mesh seeds will cause them to be placed closer together towards one end
of an edge. A two way bias will space the mesh seeds further apart at the center of an edge and closer
together towards the ends of the edge.
Example:
Description:
This function will create and display FEM mesh seeds on a selection of curves based on the allowable
curve error and either the number of mesh seeds per element or the length of an element.
Input:
STRING curve_select[] This value specifies a selection of curves to be
seeded.
STRING element_length_type[31] This value specifies an element length type of either
Uniform or Variable.
REAL allow_curve_error This value specifies the allowable curvature error
which must be greater than 0.
STRING constraint_option[31] This value specifies the element constraint option of
either Length or Number. This value is used to
select between the use of the input values
minimum_id_length and maximum_id_length or
minimum_number and maximum_number.
REAL minimum_id_length This value specifies the minimum length of an
element that will be seeded. This value must be equal
to or greater than 0 and is used only when the input
value constraint_option is set to Length.
REAL maximum_id_length This value specifies the maximum length of an
element that will be seeded. This value must be
greater than the input value minimum_id_length and
is used only when the input value constraint_option
is set to Length.
INTEGER minimum_number This value specifies the minimum number of mesh
seeds that will be placed on an element. This value
must be greater than 0 and is used only when the
input value constraint_option is set to Number.
INTEGER maximum_number This value specifies the maximum number of mesh
seeds that will be placed on an element. This value
must be greater than the input value
minimum_number and is used only when the input
value constraint_option is set to Number.
1054 PCL Reference Manual
Create Action
Output:
None.
Error Conditions:
None.
Example:
Description:
This function will create and display FEM mesh seeds at specific points on a selection of curves using
a table of either percentage values of the arc length or of the parametric length of a curve.
Input:
STRING curve_select[] This value specifies a selection of curves to be
seeded.
STRING coord_type[] This value specifies the coordinate type used
in the input value table_of_values and can be
set to either Arc Length or Parametric.
INTEGER num_entries This value specifies the number of entries in
the input value table_of_values.
REAL table_of_values(num_entries + 2) This value specifies a table of either
percentage values of the arc length or of the
parametric length of a curve. The number of
offsets allocated for this array should be two
greater than the input value num_entries to
allow for the inclusion of the values 0.0 and
1.0. All entries in this table can range from 0.0
to 1.0.
Output:
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
Chapter 4: Finite Element Functions 1055
Create Action
Example:
Description:
This function will create and display FEM mesh seeds at specific points on a selection of curves
using a table of either percentage values of the arc length or of the parametric length of a curve.
Input:
STRING curve_select[] This value specifies a selection of curves to be
seeded.
STRING coord_type[] This value specifies the coordinate type used
in the input value table_of_values and can be
set to either Arc Length or Parametric.
INTEGER num_entries This value specifies the number of entries in
the input value table_of_values.
STRING table_of_values(num_entries + 2)
This value specifies a table of either
percentage values of the arc length or of the
parametric length of a curve. The number of
offsets allocated for this array should be two
greater than the input value num_entries to
allow for the inclusion of the values 0.0 and
1.0. All entries in this table can range from 0.0
to 1.0. Table_of_values is a string array so
that each element can support unevaluated
PCL expressions.
Output:
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message
in the message database.
Example:
None.
1056 PCL Reference Manual
Create Action
Description:
This function will create a mesh seed on a curve or an edge using the nodes, points or locations
provided in the point_list. The points (nodes) should lie within tolerance specified.
Input:
STRING curve_list[VIRTUAL] This value specifies a list of curves or edges on
which mesh seed needs to be created.
STRING point_list[VIRTUAL] This value specifies the list of locations. This value
could be nodes, points, or [x y z] locations.
REAL tolerance This value specifies the tolerance within which the
items in the input value point_list should lie with
respect to the curve to create a tabular mesh seed.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
MSG_FEM_SEED_00_ADDED - Arc length ratio 0.0 added to seed table for start point of curve.
MSG_FEM_SEED_10_ADDED - Arc length ratio 1.0 added to seed table for end point of curve.
While the above two can be ignored all other error messages should be handled as the situation
warrants.
See the Status Messages for information on any error values returned by this function.
Example:
mesh_seed_display_mgr.init ()
Description:
This function will initialize the mesh seed display manager.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
This function must be called before any other call is made to the mesh seed display manager.
Example:
mesh_seed_display_mgr.plot ()
Description:
This function will display all visible mesh seeds in the current viewport.
Input:
None.
Output:
None.
Error Conditions:
None.
Example:
mesh_seed_display_mgr_erase ()
Description:
This function will erase all visible mesh seeds in the current viewport.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
This function does not modify the mesh seeds defined in the database, it just erases the mesh seeds from
the current viewport.
Example:
mesh_seed_display_mgr.refresh ()
Description:
This function will refresh the mesh seed shown in the current viewport if the mesh seeds are displayed.
Input:
None.
Output:
None.
Error Conditions:
None.
Example:
Description:
This function will create freebody fields.
Input:
STRING ufb_method[] Freebody method "Freebody Loads", "Interface Loads" or
"Forced Displacements"
STRING uresult_title[] Result title
STRING usubcase_title[] Subcase title
INTEGER usubcase_id Subcase id
STRING uresult_type[] Result type
STRING dummy0[] Constant set to "Summation Point"
STRING usummation_pt[] Summation point
STRING dummy1[] Constant set to "Transform Results"
LOGICAL utransform_on Transformation flag, If FALSE use Analysis Coord Frame.
STRING ucoord_sys[] Transform coordinate system. Used if "utransform" is
TRUE.
STRING dummy2[] Constant set to "Entity List"
STRING uelement_list[] Entities of interest
STRING dummya[] Constant set to "Planar Data"
LOGICAL uplanar TRUE if plane is active
STRING uplane[] Active plane if "uplanar" is TRUE
STRING dummy8[] Interface method
1060 PCL Reference Manual
Create Action
1. Overwrite
2. Increment
3. Dummy (Old Append flag)
Notes: The Overwrite and Increment flags cannot both be
TRUE. Leave the Append flag FALSE.
STRING uforce_field_name[] Force field (base) name
INTEGER uforce_inc_start See Note Below
STRING dummy6[] Moment Field type: "Moment Field" or "Rotational
Displacement Field"
LOGICAL umoment_field_on Flag for creating a Moment field
LOGICAL umoment_opts() Three Flags: (See "uforce_opts" notes)
STRING umoment_field_name[] Moment field (base) name
INTEGER umoment_inc_start See Note Below
STRING dummy7[] Constant set to "New LBC Set"
LOGICAL ulbc_on Flag for assigning field to lbc
LOGICAL ulbc_opts() Three Flags: (See "uforce_opts" notes)
STRING ulbc_labels[]() Two Strings:
LOGICAL ulc_insert If TRUE: The new LBC is inserted into the given LC. If
the LC doesn't exist, it is created.
Example:
None.
1062 PCL Reference Manual
Transform Action
Transform Action
This section is used to describe some of the functions used to mirror, rotate, and translate finite element
model nodes, elements, multi-point constraints (MPCs), meshes, and mesh seeds.
Description:
This function will do a mirror translation on selected elements.
Input:
STRING new_eid_list[] This value specifies a selection of element identifiers
to be assigned to the newly created elements.
STRING plane_list[] This value specifies an identifier for the plane around
which the mirror transformation will be made.
REAL offset This value specifies an offset from the mirror
transformation plane.
LOGICAL reverse_elems This value specifies, when set to TRUE, that the
mirrored elements are to be reversed after mirror
transformation has been done. Setting this value to
TRUE will ensure that the jacobian values for solid
elements will remain positive. Setting this value to
FALSE may allow the creation of elements with
negative jacobian values.
INTEGER flag This value specifies, when set to 1, that the original
elements and nodes from which the sweep operation
was made will be deleted. When set to 2 this value
uses the new numbering control scheme and when set
to 3, uses the new id offset method.
STRING elem_list[] This value specifies a list of elements to mirror.
Output:
STRING created_nids[VIRTUAL] This value returns a description of the created nodes.
STRING created_eids[VIRTUAL] This value returns a description of the created
elements.
STRING deleted_nids[VIRTUAL] This value returns a description of the deleted nodes.
STRING deleted_eids[VIRTUAL] This value returns a description of the deleted
elements.
Chapter 4: Finite Element Functions 1063
Transform Action
Remarks:
Space is internally allocated for the string returned by the output values created_nids, created_eids,
deleted_nids, and deleted_eids. It is the responsibility of the calling function to free the allocated string
storage space.
This function can create and delete elements that are stored in the database and displayed in a viewport.
Example:
Description:
This function will do a rotation translation on the input list of elements.
Input:
STRING rotate_elem_select[] This value specifies a selection of element
identifiers to be assigned to the newly created
elements.
STRING axis_select[] This value specifies an identifier for the axis
around which the rotation translation will take
place.
REAL rotation_angle This value specifies the angle of rotation in
degrees.
REAL offset_angle This value specifies the offset angle for the rotation
translation in degrees.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
INTEGER repeat_number This value specifies the number of times to repeat
the rotation translation.
1064 PCL Reference Manual
Transform Action
INTEGER flag This value specifies, when set to 1, that the original
elements and nodes from which the sweep
operation was made will be deleted. When set to 2
this value uses the new numbering control scheme
and when set to 4, uses the new id offset method.
STRING element_select[] This value specifies a list of elements to rotate.
Output:
STRING nodes_created[VIRTUAL] This value returns a description of the created
nodes.
STRING elements_created[VIRTUAL] This value returns a description of the created
elements.
STRING nodes_deleted[VIRTUAL] This value returns a description of the deleted
nodes.
STRING elements_deleted[VIRTUAL] This value returns a description of the deleted
elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output values nodes_created, elements_created,
nodes_deleted, and elements_deleted. It is the responsibility of the calling function to free the allocated
string storage space.
This function can create and delete elements that are stored in the database and displayed in a viewport.
Example:
Description:
This function will do a mirror translation on the input list of nodes.
Input:
STRING new_nid_list[] This value specifies a selection of node identifiers
to be assigned to the newly created nodes.
STRING plane_list[] This value specifies an identifier for the axis
around which the mirror translation will take place.
REAL offset This value specifies an offset from the mirror
transformation plane.
INTEGER flag This value specifies, when set to 1, that the original
elements and nodes from which the sweep
operation was made will be deleted. When set to 2
this value uses the new numbering control scheme
and when set to 3, uses the new id offset method.
STRING node_list[] This value specifies a list of nodes to mirror.
Output:
STRING created_nids[VIRTUAL] This value returns a description of the created
nodes.
STRING deleted_ids[VIRTUAL] This value returns a description of the deleted
nodes.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output values created_nids and deleted_ids. It
is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements that are stored in the database and displayed in a viewport.
Example:
Description:
This function will do a rotation translation on the input list of nodes.
Input:
STRING rotate_node_select[] This value specifies a selection of node identifiers
to be assigned to the newly created nodes.
STRING axis_select[] This value specifies an identifier for the axis
around which the rotation translation will take
place.
REAL rotation_angle This value specifies the angle of rotation in
degrees.
REAL offset_angle This value specifies the offset angle for the rotation
translation in degrees.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
INTEGER repeat_number This value specifies the number of times to repeat
the rotation translation.
INTEGER flag This value specifies, when set to 1, that the original
elements and nodes from which the sweep
operation was made will be deleted. When set to 2
this value uses the new numbering control scheme
and when set to 4, uses the new id offset method.
STRING node_select[] This value specifies a list of elements to rotate.
Output:
STRING nodes_created[VIRTUAL] This value returns a description of the created
nodes.
STRING nodes_deleted[VIRTUAL] This value returns a description of the deleted
nodes.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Chapter 4: Finite Element Functions 1067
Transform Action
Remarks:
Space is internally allocated for the string returned by the output values nodes_created, and
nodes_deleted. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements that are stored in the database and displayed in a viewport.
Example:
Description:
This function will do a translation operation on the input list of nodes.
Input:
STRING trans_node_select[] This value specifies a selection of node identifiers
to be assigned to the newly created nodes.
STRING vector_select[] This value specifies an identifier for the vector
describing the direction and distance used for the
translation operation.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
INTEGER repeat_number This value specifies the number of times to repeat
the translation operation.
LOGICAL transform_type This value specifies, when set to TRUE, that the
local coordinate system will used to interpret the
input value vector_select. If this value is set to
FALSE it will be assumed that the input value
vector_select specifies a vector in cartesian
coordinates.
INTEGER flag This value specifies, when set to 1, that the original
elements and nodes from which the sweep
operation was made will be deleted. When set to 2
this value uses the new numbering control scheme
and when set to 4, uses the new id offset method.
STRING node_select[] This value specifies a list of nodes to translate.
Output:
1068 PCL Reference Manual
Transform Action
Remarks:
Space is internally allocated for the string returned by the output values nodes_created, and
nodes_deleted. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements that are stored in the database and displayed in a viewport.
Example:
Description:
This function will do a translation operation on the input list of nodes.
Input:
STRING assigned_ids[] This value specifies a selection of node identifiers
to be assigned to the newly created nodes. Default
"#" (Next available id)
STRING vector_select[] This value specifies an identifier for the vector
describing the direction and distance used for the
translation operation. Default "<1 0 0>"
REAL magnitude The distance to translate in the specified vector
direction. Default is the magnitude of the direction
vector, e.g. 1.
LOGICAL reverse_dir This value specifies, when set to TRUE, to
translate in the negative direction of the translation
vector. If FALSE, in the positive direction. Default
is FALSE
Chapter 4: Finite Element Functions 1069
Transform Action
Remarks:
Space is internally allocated for the string returned by the output values nodes_created and
nodes_deleted. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements that are stored in the database and displayed in a viewport.
Description:
This function will do a translation operation on the input list of elements.
1070 PCL Reference Manual
Transform Action
Input:
STRING trans_elem_select[] This value specifies a selection of element
identifiers to be assigned to the newly created
elements.
STRING vector_select[] This value specifies an identifier for the vector
describing the direction and distance used for the
translation operation.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
INTEGER repeat_number This value specifies the number of times to repeat
the translation operation.
LOGICAL transform_type This value specifies, when set to TRUE, that the
local coordinate system will used to interpret the
input value vector_select. If this value is set to
FALSE it will be assumed that the input value
vector_select specifies a vector in cartesian
coordinates.
INTEGER flag This value specifies, when set to 1, that the
original elements and nodes from which the sweep
operation was made will be deleted. When set to 2
this value uses the new numbering control scheme
and when set to 4, uses the new id offset method.
STRING elem_select[] This value specifies a list of elements to translate.
Output:
STRING nodes_created[VIRTUAL] This value returns a description of the created
nodes.
STRING elements_created[VIRTUAL] This value returns a description of the created
elements.
STRING nodes_deleted[VIRTUAL] This value returns a description of the deleted
nodes.
STRING elements_deleted[VIRTUAL] This value returns a description of the deleted
elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Chapter 4: Finite Element Functions 1071
Transform Action
Remarks:
Space is internally allocated for the string returned by the output values nodes_created, elements_created,
nodes_deleted, and elements_deleted. It is the responsibility of the calling function to free the allocated
string storage space.
This function can create and delete elements that are stored in the database and displayed in a viewport.
Example:
Description:
This function will do a translation operation on the input list of elements.
Input:
STRING trans_elem_select[] This value specifies a selection of element
identifiers to be assigned to the newly created
elements.
STRING vector_select[] This value specifies an identifier for the vector
direction used for the translation operation.
REAL vector_magnitude This value specifies an identifier for the vector
magnitude used for the translation operation.
LOGICAL reverse_dir This value specifies, when set to TRUE, that the
vector direction will be reversed. If this vale is
set to FALSE, vector direction will not be
reversed.
STRING ref_coord_frame[] This value specifies an identifier for the
reference coordinate frame.
INTEGER repeat_number This value specifies the number of times to
repeat the translation operation.
LOGICAL transform_type This value specifies, when set to TRUE, that the
local coordinate system will be used to interpret
the input value vector_select. If this value is set
to FALSE, it will be assumed that the input
value vector_select specifies a vector in
cartesian coordinates.
1072 PCL Reference Manual
Transform Action
Remarks:
Space is internally allocated for the string returned by the output values nodes_created, elements_created,
nodes_deleted, and elements_deleted. It is the responsibility of the calling function to free the allocated
string storage space.
This function can create and delete elements that are stored in the database and displayed in a viewport.
Chapter 4: Finite Element Functions 1073
Sweep Action
Sweep Action
This section is used to describe some of the functions used to duplicate and/or translate finite element
model nodes, elements, multi-point constraints (MPCs), meshes, and mesh seeds through the use of
sweep operations.
Sweeping elements is the process of creating higher order elements by sweeping a lower order element
through a prescribed path. Therefore, a hexagonal element may be created by sweeping a quadrilateral
element through space, the edges of the hexagonal being defined by the corners of the quadrilateral as its
nodes move along the path. Ten methods for defining the swept paths are provided: arc, extrude, glide,
glide-guide, normal, radial cylindrical, radial spherical, spherical theta, vector field and loft.
Description:
This function will create elements by using the arc sweep method.
Input:
STRING sweep_elem_select[] This value specifies a selection of element identifiers
to be assigned to the newly created elements.
STRING sweep_node_select[] This value specifies a selection of node identifiers to
be assigned to the newly created nodes.
STRING arc_angle[] This value specifies the range of the arc swept in
degrees.
STRING arc_coord_frame[] This value specifies an identifier for the coordinate
frame in which the axis of rotation is defined.
STRING axis_rotation[] This value specifies an identifier for the axis of
rotation in the input value arc_coord_frame around
which the arc sweep operation will take place.
STRING offset_angle[] This value specifies the offset angle in degrees
between the location of the entities on which the
sweep operation will take place and the location
along the arc where the entities created by the sweep
operation will be placed.
INTEGER flag This value specifies, when set to 1, that the original
elements and nodes from which the sweep operation
was made will be deleted. When set to 2 this value
uses the new numbering control scheme.
1074 PCL Reference Manual
Sweep Action
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Arc.
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
Description:
This function will create elements by using the radial cylindrical sweep method. This operation will
create entities by sweeping along a cylindrical radius that passes through the selected entities and is
normal to the cylinder axis.
Input:
STRING sweep_elem_select[] This value specifies a selection of element
identifiers to be assigned to the newly created
elements.
STRING sweep_node_select[] This value specifies a selection of node identifiers
to be assigned to the newly created nodes.
STRING cyl_coord_frame[] This value specifies an identifier for the
coordinate frame in which the cylinder axis is
defined.
1076 PCL Reference Manual
Sweep Action
Remarks:
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Radial Cyl..
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
Description:
This function will create elements by using the extrude sweep method.
Input:
STRING sweep_elem_select[] This value specifies a selection of element
identifiers to be assigned to the newly created
elements.
STRING sweep_node_select[] This value specifies a selection of node
identifiers to be assigned to the newly created
nodes.
STRING vector_coord_frame[] This value specifies an identifier for the
coordinate frame in which the axis of rotation is
defined.
STRING vector_direction[] This value specifies a vector that defines the
direction in which the extrusion operation will
create new entities.
STRING extrusion_distance[] This value specifies the distance along the
extrusion vector over which new entities will be
created.
STRING offset_distance[] This value specifies the distance between the
location of the entities on which the sweep
operation will take place and the location along
the extrusion vector where the entities created
by the sweep operation will be placed.
INTEGER flag This value specifies, when set to 1, that the
original elements from which the sweep
operation was made will be deleted. When set to
2 this value uses the new numbering control
scheme.
STRING entity_select[] This value specifies a list of entities on which
the sweep operation will take place.
Chapter 4: Finite Element Functions 1079
Sweep Action
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Extrude.
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
Description:
This function will create elements by using the glide sweep method.
Input:
STRING sweep_elem_select[] This value specifies a selection of element identifiers
to be assigned to the newly created elements.
STRING sweep_node_select[] This value specifies a selection of node identifiers to be
assigned to the newly created nodes.
STRING glide_coord_frame[] This value specifies an identifier for the coordinate
frame in which the glide points are defined.
STRING glide_type[] This value specifies the type of glide operation that
will take place. Currently only the case insensitive
value FIXED is allowed.
STRING glide_curve[] This value specifies the curve used for the gliding
offset, the glide direction tangent, and the glide frame
origin.
Chapter 4: Finite Element Functions 1081
Sweep Action
STRING glide_beginning[] This value specifies a point that defines the beginning
of the glide curve. This value is used to define an offset
along the glide curve for the start of placement of
entities created by the sweep operation.
STRING glide_end[] This value specifies a point that defines the end of the
glide curve.
LOGICAL reverse_glide This value specifies, when set to TRUE, that the
direction of the glide path along the glide curve be
reversed.
LOGICAL offset_glide This value specifies, when set to TRUE, the use of an
offset for the entities created along the glide curve by
the sweep operation defined by either the input value
glide_beginning or by the input value glide_end,
depending on the input value reverse_glide.
LOGICAL glide_parameter This value specifies, when set to TRUE, that the glide
operation will take place in the curve parameter space
rather than the arc length space.
LOGICAL glide_pnts_parametric This value specifies, when set to TRUE, that the
beginning and the end point for the glide curve are
defined as curve parametric locations rather than as
points in the global coordinate frame.
INTEGER flag This value specifies, when set to 1, that the original
elements and nodes from which the sweep operation
was made will be deleted. When set to 2 this value uses
the new numbering control scheme.
STRING entity_select[] This value specifies a list of entities on which the
sweep operation will take place.
INTEGER num_topologies This value specifies the number of sweep topology
conversion pairs and should be set to the value 10.
STRING sweep_topologies[] This value specifies an array of selections of elements
(num_topologies) used to define the relationship between the types of
entities on which the sweep operation will take place
and the entities that the sweep operation will create
from those entities. The offset into the array is used to
define the type of entity from which the geometry will
be extended and the value at that offset will define the
entity created from the starting geometric type. See the
Sweep Function Input Value Tables at the end of this
section for a list of values that can be used with this
argument.
STRING anly_coord_frame[] This value specifies an identifier for the analysis
coordinate frame.
1082 PCL Reference Manual
Sweep Action
Remarks:
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Glide.
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
fem_sweep_glide_guide_1 (sweep_elem_select,
sweep_node_select, glide_coord_frame,
glide_curve, glide_beginning, glide_end,
reverse_glide, offset_glide,
glide_parameter, glide_pnts_parametric,
flag, entity_select, guide_curve,
guide_beginning, guide_end,
reverse_guide, offset_guide,
guide_parameter, guide_pnts_parameter,
preserve_guide_axis, num_topologies,
sweep_topologies, anly_coord_frame,
ref_coord_frame, mesh_control_type,
mesh_control, num_nodes,
num_elements, nodes_created,
elements_created)
Description:
This function will create elements by using the glide-guide sweep method.
Input:
STRING sweep_elem_select[] This value specifies a selection of element
identifiers to be assigned to the newly created
elements.
STRING sweep_node_select[] This value specifies a selection of node identifiers
to be assigned to the newly created nodes.
STRING glide_coord_frame[] This value specifies an identifier for the
coordinate frame in which the glide points are
defined.
STRING glide_curve[] This value specifies the curve used for the gliding
offset, the glide direction tangent, and the glide
frame origin.
STRING glide_beginning[] This value specifies a point that defines the
beginning of the glide curve. This value is used to
define an offset along the glide curve for the start
of placement of entities created by the sweep
operation.
STRING glide_end[] This value specifies a point that defines the end of
the glide curve.
LOGICAL reverse_glide This value specifies, when set to TRUE, that the
direction of the glide path along the glide curve be
reversed.
1084 PCL Reference Manual
Sweep Action
LOGICAL offset_glide This value specifies, when set to TRUE, that the
use of an offset for the entities created along the
glide curve by the sweep operation be defined by
either the input value glide_beginning or by the
input value glide_end, depending on the input
value reverse_glide.
LOGICAL glide_parameter This value specifies, when set to TRUE, that the
glide operation will take place in the curve
parameter space rather than the arc length space.
LOGICAL glide_pnts_parametric This value specifies, when set to TRUE, that the
beginning and the end point for the glide curve are
defined as curve parametric locations rather than
as points in the global coordinate frame.
INTEGER flag This value specifies, when set to 1, that the
original elements and nodes from which the sweep
operation was made will be deleted. When set to 2
this value uses the new numbering control
scheme.
STRING entity_select[] This value specifies a list of entities on which the
sweep operation will take place.
STRING guide_curve[] This value specifies the curve used to guide the
glide frame orientation as the sweep operation
glides along the glide curve.
STRING guide_beginning[] This value specifies a point that defines the
beginning of the guide curve.
STRING guide_end[] This value specifies a point that defines the end of
the guide curve.
LOGICAL reverse_guide This value specifies, when set to TRUE, that the
direction of the guide path along the guide curve
be reversed.
LOGICAL offset_guide This value specifies, when set to TRUE, that the
use of an offset for the entities created along the
guide curve by the sweep operation be defined by
either the input value guide_beginning or the input
value guide_end.
LOGICAL guide_parameter This value specifies, when set to TRUE, that the
guide operation will take place in the curve
parameter space rather than the arc length space.
Chapter 4: Finite Element Functions 1085
Sweep Action
LOGICAL guide_pnts_parameter This value specifies, when set to TRUE, that the
beginning and the end point for the guide curve are
defined as curve parametric locations rather than
as points in the global coordinate frame.
LOGICAL preserve_guide_axis This value specifies, when set to TRUE, that the
guide curve reference direction rather than the
glide curve tangent direction be used when
rotating the glide frame orientation along the
guide path.
INTEGER num_topologies This value specifies the number of sweep
topology conversion pairs and should be set to the
value 10.
STRING sweep_topologies[] This value specifies an array of selections of
(num_topologies) elements used to define the relationship between
the types of entities on which the sweep operation
will take place and the entities that the sweep
operation will create from those entities. The
offset into the array is used to define the type of
entity from which the geometry will be extended
and the value at that offset will define the entity
created from the starting geometric type. See the
Sweep Function Input Value Tables at the end of
this section for a list of values that can be used
with this argument.
STRING anly_coord_frame[] This value specifies an identifier for the analysis
coordinate frame.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
STRING mesh_control_type[] This value specifies the type of mesh control to be
used with the arc sweep operation. See the Sweep
Function Input Value Tables at the end of this
section for a list of values that can be used with
this argument.
STRING mesh_control[](6) This value specifies mesh control parameters. See
the Sweep Function Input Value Tables at the
end of this section for a list of values that can be
used with this argument.
Output:
INTEGER num_nodes This value returns the number of nodes created by
the sweep operation.
INTEGER num_elements This value returns the number of elements created
by the sweep operation.
1086 PCL Reference Manual
Sweep Action
Remarks:
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Glide - Guide.
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
Description:
This function will create elements by using the loft sweep method.
Input:
STRING sweep_elem_select[] This value specifies a selection of element identifiers
to be assigned to the newly created elements.
STRING sweep_node_select[] This value specifies a selection of node identifiers to be
assigned to the newly created nodes.
STRING entity_select[] This value specifies a list of entities on which the
sweep operation will take place.
STRING top_elements[] This value specifies a selection of element identifiers
that define the top of the sweep operation.
STRING start_element[] This value specifies the starting element in the
selection of entities on which the sweep operation will
take place.
STRING start_element_top[] This value specifies the starting element in the
selection of element identifiers that define the top of
the sweep operation.
INTEGER flag This value specifies, when set to 1, that the original
elements and nodes from which the sweep operation
was made will be deleted. When set to 2 this value uses
the new numbering control scheme.
LOGICAL auto_align This value specifies, when set to TRUE, that the
starting elements specified by the input values
start_element and start_element_top will be aligned.
INTEGER num_topologies This value specifies the number of sweep topology
conversion pairs and should be set to the value 10.
1088 PCL Reference Manual
Sweep Action
Remarks:
Chapter 4: Finite Element Functions 1089
Sweep Action
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Loft.
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
Description:
This function will create elements by using the normal sweep method.
Input:
STRING sweep_elem_select[] This value specifies a selection of element
identifiers to be assigned to the newly created
elements.
STRING sweep_node_select[] This value specifies a selection of node
identifiers to be assigned to the newly created
nodes.
STRING normal_distance[] This value specifies the distance along the
normal of each element selected for the sweep
operation over which the sweep operation will
create new elements.
STRING offset_distance[] This value specifies the distance between the
location of the entities on which the sweep
operation will take place and the location along
the element normals where the entities created
by the sweep operation will be placed.
LOGICAL reverse_normal This value specifies, when set to TRUE, that the
normals used by the sweep operation be
reversed.
1090 PCL Reference Manual
Sweep Action
Remarks:
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Normal.
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
Description:
This function will create elements by using the normal sweep method.
Input:
STRING sweep_elem_select[] This value specifies a selection of element
identifiers to be assigned to the newly created
elements.
STRING sweep_node_select[] This value specifies a selection of node identifiers
to be assigned to the newly created nodes.
1092 PCL Reference Manual
Sweep Action
STRING normal_distance[] This value specifies the distance along the normal
of each element selected for the sweep operation
over which the sweep operation will create new
elements.
STRING offset_distance[] This value specifies the distance between the
location of the entities on which the sweep
operation will take place and the location along
the element normals where the entities created by
the sweep operation will be placed.
LOGICAL reverse_normal This value specifies, when set to TRUE, that the
normals used by the sweep operation be reversed.
INTEGER flag This value specifies, when set to 1, that the
original elements and nodes from which the sweep
operation was made will be deleted. When set to 2
this value uses the new numbering control
scheme.
LOGICAL ignore_geometry If this value is set to TRUE, the geometry is
ignored.
STRING entity_select[] This value specifies a list of entities on which the
sweep operation will take place.
INTEGER num_topologies This value specifies the number of sweep
topology conversion pairs and should be set to the
value 10.
STRING sweep_topologies[] This value specifies an array of selections of
(num_topologies) elements used to define the relationship between
the types of entities on which the sweep operation
will take place and the entities that the sweep
operation will create from those entities. The
offset into the array is used to define the type of
entity from which the geometry will be extended
and the value at that offset will define the entity
created from the starting geometric type. See the
Sweep Function Input Value Tables at the end of
this section for a list of values that can be used
with this argument.
STRING anly_coord_frame[] This value specifies an identifier for the analysis
coordinate frame.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
Chapter 4: Finite Element Functions 1093
Sweep Action
Remarks:
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Normal.
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
Please see fem_sweep_normal_1 (p. 773) in the PCL Reference Manual Examples.
1094 PCL Reference Manual
Sweep Action
Description:
This function will create elements by using the spherical theta sweep method. This operation will
create entities by sweeping a spherical radius that passes through the selected entities and is normal
to the axis of the sphere through which the spherical radius is swept around the axis of the sphere.
Input:
STRING sweep_elem_select[] This value specifies a selection of element
identifiers to be assigned to the newly created
elements.
STRING sweep_node_select[] This value specifies a selection of node
identifiers to be assigned to the newly created
nodes.
STRING sphere_coord_frame[] This value specifies an identifier for the
coordinate frame in which the spherical axis is
defined.
STRING axis_spherical[] This value specifies an identifier for the
spherical axis from which a spherical radius will
be projected.
STRING sweep_angle[] This value specifies the angle to be swept by the
spherical radius in degrees.
STRING angle_offset[] This value will specify an angle in degrees
defining an offset along the spherical radius
between the entities on which the sweep
operation will take place and the location along
the cylindrical radius where the entities created
by the sweep operation will be placed.
INTEGER flag This value specifies, when set to 1, that the
original elements and nodes from which the
sweep operation was made will be deleted.
When set to 2 this value uses the new
numbering control scheme.
STRING entity_select[] This value specifies a list of entities on which
the sweep operation will take place.
Chapter 4: Finite Element Functions 1095
Sweep Action
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Sph. Theta.
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
Please see fem_sweep_sphere_angle_1 (p. 775) in the PCL Reference Manual Examples.
Description:
This function will create elements by using the radial spherical method. This operation will create
entities by sweeping along a spherical radius that passes from the center of a sphere and through the
entities selected for this sweep operation.
Input:
STRING sweep_elem_select[] This value specifies a selection of element identifiers
to be assigned to the newly created elements.
STRING sweep_node_select[] This value specifies a selection of node identifiers to
be assigned to the newly created nodes.
STRING sphere_coord_frame[] This value specifies an identifier for the coordinate
frame in which the sphere axis is defined.
STRING sphere_center[] This value specifies a point that will be used as the
center of a sphere from which a spherical radius will
be projected.
Chapter 4: Finite Element Functions 1097
Sweep Action
STRING radial_distance[] This value will specify the distance along the
spherical radius where the created entities will be
placed.
STRING offset_distance[] This value will specify an offset distance along the
spherical radius between the entities on which the
sweep operation will take place and the location
along the spherical radius where the entities created
by the sweep operation will be placed.
INTEGER flag This value specifies, when set to 1, that the original
elements and nodes from which the sweep operation
was made will be deleted. When set to 2 this value
uses the new numbering control scheme.
STRING entity_select[] This value specifies a list of entities on which the
sweep operation will take place.
INTEGER num_topologies This value specifies the number of sweep topology
conversion pairs and should be set to the value 10.
STRING sweep_topologies[] This value specifies an array of selections of
(num_topologies) elements used to define the relationship between the
types of entities on which the sweep operation will
take place and the entities that the sweep operation
will create from those entities. The offset into the
array is used to define the type of entity from which
the geometry will be extended and the value at that
offset will define the entity created from the starting
geometric type. See the Sweep Function Input
Value Tables at the end of this section for a list of
values that can be used with this argument.
STRING anly_coord_frame[] This value specifies an identifier for the analysis
coordinate frame.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame.
STRING mesh_control_type[] This value specifies the type of mesh control to be
used with the arc sweep operation. See the Sweep
Function Input Value Tables at the end of this
section for a list of values that can be used with this
argument.
STRING mesh_control[](6) This value specifies mesh control parameters. See
the Sweep Function Input Value Tables at the end
of this section for a list of values that can be used
with this argument.
1098 PCL Reference Manual
Sweep Action
Output:
INTEGER num_nodes This value returns the number of nodes created by
the sweep operation.
INTEGER num_elements This value returns the number of elements created by
the sweep operation.
STRING nodes_created[VIRTUAL] This value returns a description of the created nodes.
STRING elements_created This value returns a description of the created
[VIRTUAL] elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Radial Sph..
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
Description:
This function will create elements by using the vector field sweep method.
Input:
Chapter 4: Finite Element Functions 1099
Sweep Action
Remarks:
This function is used to implement the functionality behind the form accessed by the Finite Elements
switch bar selection when the Action: switch is set to Sweep, the Object: switch is set to
Element, and the Method switch is set to Vector Field.
Space is internally allocated for the string returned by the output values nodes_created and
elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a
viewport.
Example:
Please see fem_sweep_vector_field_1 (p. 780) in the PCL Reference Manual Examples.
The tables listed below describe the values that can be used with the sweep functions described in this
section of the chapter.
1 Point Bar2
1 Point Bar3
1 Point Bar4
2 Bar2 Quad4
3 Bar3 Quad8
4 Bar4 Quad12
5 Tri3 Wedge6
6 Tri6 Wedge15
7 Tri9 Wedge24
8 Quad4 Hex8
9 Quad8 Hex20
10 Quad12 Hex32
1102 PCL Reference Manual
Sweep Action
Offset Description
1 This offset is used to define the number of elements created when the input value
mesh_control_type is set to One_Way_Bias: Num Elems and L2/L1 or
Two_Way_Bias: Num Elems and L2/L1. This value must represent an integer that is
greater than 0.
2 This offset is used to define the ratio of L2/ L1 when the input value mesh_control_type
is set to One_Way_Bias: Num Elems and L2/L1 or Two_Way_Bias: Num Elems and
L2/L1. This value must represent a real number that is greater than 0.
3 This offset is used to define the length of L1 when the input value mesh_control_type is
set to One_Way_Bias: L1 and L2 or Two_Way_Bias: L1 and L2. This value must
represent a real number that is greater than 0.
4 This offset is used to define the length of L2 when the input value mesh_control_type is
set to One_Way_Bias: L1 and L2 or Two_Way_Bias: L1 and L2. This value must
represent a real number that is greater than 0.
5 This offset is used to define the element length used when the input value
mesh_control_type is set to Uniform: Element Length. This value must represent a real
number that is greater than 0.
6 This offset is used to define the number of elements created when the input value
mesh_control_type is set to Uniform: Number of Elements. This value must represent
an integer that is greater than 0.
Chapter 4: Finite Element Functions 1103
Renumber Action
Renumber Action
This section is used to describe some of the functions used to renumber the identifiers used to reference
a selection of finite element model (FEM) nodes or elements.
Description:
This function will renumber a selection of element identifiers in either a consecutive manner beginning
with a starting element identifier or as directed by a selection of element identifiers.
Input:
STRING original_selection[] This value specifies a selection of element
identifiers that will be renumbered.
STRING new_selection[] This value specifies a selection of element
identifiers to which the original elements will be
renumbered. If there is only one element identifier
in the selection the original element identifiers
will be renumbered in a consecutive manner. If
more than one element identifier is provided, the
identifiers in the input value original_selection
will be renumbered to match the identifiers
specified by this input value.
INTEGER flag When set to 2, this value specifies use of the new
numbering control scheme. When set to 4, this
value specifies use of the new id offset method.
Output:
STRING created_selection[VIRTUAL] This value returns a description of the renumbered
element identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output value created_selection. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the element identifiers that are stored in the database and displayed in a
viewport.
1104 PCL Reference Manual
Renumber Action
Example:
Please see fem_renum_elem_1 (p. 783) in the PCL Reference Manual Examples.
Description:
This function will renumber a selection of node identifiers in either a consecutive manner beginning
with a starting node identifier or as directed by a selection of node identifiers.
Input:
STRING original_selection[] This value specifies a selection of node identifiers
that will be renumbered.
STRING new_selection[] This value specifies a selection of node identifiers
to which the original nodes will be renumbered. If
there is only one node identifier in the selection
the original node identifiers will be renumbered in
a consecutive manner. If more than one node
identifier is provided, the identifiers in the input
value original_selection will be renumbered to
match the identifiers specified by this input value.
INTEGER flag When set to 2, this value specifies use of the new
numbering control scheme. When set to 4, this
value specifies use of the new id offset method.
Output:
INTEGER created_selection[VIRTUAL] This value returns a description of the renumbered
node identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Space is internally allocated for the string returned by the output value created_selection. It is the
responsibility of the calling function to free the allocated string storage space.
This function will update the node identifiers that are stored in the database and displayed in a viewport.
Example:
Please see fem_renum_node_1 (p. 784) in the PCL Reference Manual Examples.
Chapter 4: Finite Element Functions 1105
Renumber Action
Description:
This function will renumber a selection of connectors.
Input:
STRING conn_list List of connectors to renumber (e.g. CONN 2 3
5:10)
STRING new_id_list List of IDs to be assigned (e.g. 500)
INTEGER flag Control options (6=offset)
Output:
STRING new_idsirtual string containing a This value returns a description of the
list of new IDs renumbered node identifiers.
(e.g. Connector 502 503
505:510).
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
0 Success
-1 Memory error
>0 Database error
1106 PCL Reference Manual
Disassociate Action
Disassociate Action
This section is used to describe some of the functions used to disassociate the identifiers used to reference
a selection of finite element model (FEM) nodes or elements.
Description:
This function will disassociate the FEM entities from the list of geometry in the input value geo_list.
Input:
LOGICAL nodes This value specifies, when set to TRUE, to
disassociate the nodes of the elements.
LOGICAL elements This value specifies, when set to TRUE, to
disassociate the elements.
STRING geo_list[VIRTUAL] This value specifies the list of geometry to
disassociate FEM from.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Example:
Please see fem_disassoc_geo (p. 786) in the PCL Reference Manual Examples.
Chapter 4: Finite Element Functions 1107
Disassociate Action
Description:
This function will disassociate the FEM entities in the input value fem_list.
Input:
INTEGER option This value specifies an option to specify which FEM
entities to disassociate.
STRING fem_list[VIRTUAL] This value specifies a list of FEM entities to
disassociate.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Example:
Please see fem_disassoc_ids (p. 787) in the PCL Reference Manual Examples.
1108 PCL Reference Manual
Equivalence Action
Equivalence Action
This section is used to describe some of the functions used to reduce all of the finite element model nodes
that coexist at a point in the model space to a single node.
Description:
This function will reduce all nodes that coexist at single points to single nodes. The nodes are identi-
fied through an array of group ids.
Input:
INTEGER group_id(num_groups)
This value specifies an array of group ids identifying
the nodes to be reduced. This value is ignored if the in-
put value num_groups is set to zero.
INTEGER num_groups This value specifies the number of groups identifying
nodes to be reduced. If this value is set to zero, the en-
tire model will be reduced. This value must be equal to
or greater than zero and equal to or less than the number
of offsets defined for the input array group_id.
INTEGER tolerance_type This value specifies the type of tolerance geometry that
will be used to reduce nodes. All nodes that fit in the
tolerance region will be reduced to a single node. A cu-
bic tolerance geometry will be used if this value is set
to 1 and a spherical tolerance geometry will be used if
this value is set to 2.
REAL tolerance This value specifies the size of the tolerance region.
This value must greater than zero.
Output:
REAL updated_tolerance This value returns the size of the tolerance region, re-
calculated to prevent the collapse of element edges.
The input value tolerance is used as the starting value
for the algorithm used to calculate this value.
INTEGER segment_id This value returns the segment id for the graphics seg-
ment that needs to be cleared. This value will be set to
-1 if the graphics segment has already been cleared.
INTEGER <Return Value> This function returns a value of 0 when executed suc-
cessfully and a non zero value to indicate a change in
status or an error.
Chapter 4: Finite Element Functions 1109
Equivalence Action
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics
segment identifiers.
Example:
Description:
This function will reduce all nodes that coexist at single points to single nodes. The nodes are identi-
fied through an array of group ids. This function is identical to the fem_equiv_all_group() function
except for the addition of the input argument verify, which provides for user verification of the reduc-
tion process before the results are saved to the database.
Input:
INTEGER group_id(num_groups)
This value specifies an array of group ids identifying
the nodes to be reduced. This value is ignored if the
input value num_groups is set to zero.
INTEGER num_groups This value specifies the number of groups identifying
nodes to be reduced. If this value is set to zero, the en-
tire model will be reduced. This value must be equal
to or greater than zero and equal to or less than the
number of offsets defined for the input array
group_id.
INTEGER tolerance_type This value specifies the type of tolerance geometry
that will be used to reduce nodes. All nodes that fit in
the tolerance region will be reduced to a single node.
A cubic tolerance geometry will be used if this value
is set to 1 and a spherical tolerance geometry will be
used if this value is set to 2.
REAL tolerance This value specifies the size of the tolerance region.
This value must greater than zero.
LOGICAL verify This value specifies, when set to TRUE, that a popup
form will be used to get input from the user to either
save to the database or discard the reduction results.
If this value is set to FALSE, the reduction results
will be saved to the database without prompting from
the user.
Output:
REAL updated_tolerance This value returns the size of the tolerance region, re-
calculated to prevent the collapse of element edges.
The input value tolerance is used as the starting value
for the algorithm used to calculate this value.
Chapter 4: Finite Element Functions 1111
Equivalence Action
INTEGER segment_id This value returns the segment id for the graphics
segment that needs to be cleared. This value will be
set to -1 if the graphics segment has already been
cleared.
INTEGER <Return Value> This function returns a value of 0 when executed suc-
cessfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics
segment identifiers.
Example:
Description:
This function will reduce all nodes that coexist at single points to single nodes. The nodes are identified
through an array of group ids. This function is identical to the fem_equiv_all_group() function except
for the addition of the input argument verify, which provides for user verification of the reduction pro-
cess before the results are saved to the database and the use of group names instead of group ids.
Input:
STRING group_names[](num_groups)
This value specifies an array of group names identifying
the nodes to be reduced. This value is ignored if the input
value num_groups is set to zero.
INTEGER num_groups This value specifies the number of groups identifying
nodes to be reduced. If this value is set to zero, the entire
model will be reduced. This value must be equal to or
greater than zero and equal to or less than the number of
offsets defined for the input array group_names.
STRING crg This value specifies a string containing ids of group names
identifying the nodes to be excluded from the reduction
process.
STRING tolerance_type This value specifies the type of tolerance geometry that
will be used to reduce nodes. All nodes that fit in the toler-
ance region will be reduced to a single node. A cubic toler-
ance geometry will be used if this value is set to 1 and a
spherical tolerance geometry will be used if this value is set
to 2.
INTEGER tolerance This value specifies the size of the tolerance region. This
value must be greater than zero.
LOGICAL verify This value specifies, when set to TRUE, that a popup form
will be used to get input from the user to either save to the
database or discard the reduction results. If this value is set
to FALSE, the reduction results will be saved to the data-
base without prompting from the user.
Output:
REAL updated_tolerance This value returns the size of the tolerance region, recalcu-
lated to prevent the collapse of element edges. The input
value tolerance is used as the starting value for the algo-
rithm used to calculate this value.
Chapter 4: Finite Element Functions 1113
Equivalence Action
INTEGER segment_id This value returns the segment id for the graphics segment
that needs to be cleared. This value will be set to -1 if the
graphics segment has already been cleared.
INTEGER <Return Value> This function returns a value of 0 when executed success-
fully and a non zero value to indicate a change in status or
an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics
segment identifiers.
Example:
Description:
This function will reduce all selected nodes that coexist at a single point to a single node.
Input:
STRING node_select[] This value specifies a selection of node identifiers defining
the nodes to be reduced.
INTEGER tolerance_type This value specifies the type of tolerance geometry that
will be used to reduce nodes. All nodes that fit in the toler-
ance region will be reduced to a single node. A cubic toler-
ance geometry will be used if this value is set to 1 and a
spherical tolerance geometry will be used if this value is set
to 2.
REAL tolerance This value specifies the size of the tolerance region. This
value must greater than zero.
Output:
REAL updated_tolerance This value returns the size of the tolerance region, recalcu-
lated to prevent the collapse of element edges. The input
value tolerance is used as the starting value for the algo-
rithm used to calculate this value.
INTEGER segment_id This value returns the segment id for the graphics segment
that needs to be cleared. This value will be set to -1 if the
graphics segment has already been cleared.
INTEGER <Return Value> This function returns a value of 0 when executed success-
fully and a non zero value to indicate a change in status or
an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics
segment identifiers.
Example:
Description:
This function will reduce all selected nodes that coexist at a single point to a single node. This function
is identical to the fem_equiv_list() function except for the addition of the input argument verify, which
provides for user verification of the reduction process before the results are saved to the database.
Input:
STRING node_select[] This value specifies a selection of node identifiers defin-
ing the nodes to be reduced.
INTEGER tolerance_type This value specifies the type of tolerance geometry that
will be used to reduce nodes. All nodes that fit in the tol-
erance region will be reduced to a single node. A cubic
tolerance geometry will be used if this value is set to 1 and
a spherical tolerance geometry will be used if this value is
set to 2.
REAL tolerance This value specifies the size of the tolerance region. This
value must greater than zero.
LOGICAL verify This value specifies, when set to TRUE, that a popup
form will be used to get input from the user to either save
to the database or discard the reduction results. If this val-
ue is set to FALSE, the reduction results will be saved to
the database without prompting from the user.
Output:
REAL updated_tolerance This value returns the size of the tolerance region, recal-
culated to prevent the collapse of element edges. The in-
put value tolerance is used as the starting value for the
algorithm used to calculate this value.
INTEGER segment_id This value returns the segment id for the graphics segment
that needs to be cleared. This value will be set to -1 if the
graphics segment has already been cleared.
INTEGER <Return Value> This function returns a value of 0 when executed success-
fully and a non zero value to indicate a change in status or
an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function will display circles that highlight reduced nodes in the viewport.
1116 PCL Reference Manual
Equivalence Action
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics
segment identifiers.
Example:
Description:
This function will reduce all selected nodes that coexist at a single point to a single node. This func-
tion is identical to the fem_equiv_list2() function except for the addition of the input argument
exclude_select, which allows a selection of nodes to be excluded from the reduction process.
Input:
STRING node_select[] This value specifies a selection of node identifiers defin-
ing the nodes to be reduced.
STRING exclude_select[] This value specifies a selection of node identifiers defin-
ing the nodes to be excluded from the reduction process.
INTEGER tolerance_type This value specifies the type of tolerance geometry that
will be used to reduce nodes. All nodes that fit in the tol-
erance region will be reduced to a single node. A cubic
tolerance geometry will be used if this value is set to 1
and a spherical tolerance geometry will be used if this
value is set to 2.
REAL tolerance This value specifies the size of the tolerance region. This
value must greater than zero.
LOGICAL verify This value specifies, when set to TRUE, that a popup
form will be used to get input from the user to either save
to the database or discard the reduction results. If this val-
ue is set to FALSE, the reduction results will be saved to
the database without prompting from the user.
Output:
REAL updated_tolerance This value returns the size of the tolerance region, recal-
culated to prevent the collapse of element edges. The in-
put value tolerance is used as the starting value for the
algorithm used to calculate this value.
INTEGER segment_id This value returns the segment id for the graphics seg-
ment that needs to be cleared. This value will be set to -1
if the graphics segment has already been cleared.
INTEGER <Return Value> This function returns a value of 0 when executed success-
fully and a non zero value to indicate a change in status
or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
1118 PCL Reference Manual
Equivalence Action
Remarks:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics
segment identifiers.
Example:
Description:
This function controls the display of FEM elements and nodes.
Input:
STRING plot_option[9] This value specifies the plot option. See the remarks
below for a list of the value that can be used with this
argument.
INTEGER entity_type This value specifies the entity type for which the dis-
play will be modified. This argument can have the fol-
lowing values: 0 = both nodes and elements, 1 =
nodes, and 2 = elements.
Output:
STRING entity_selection[VIRTUAL]
This value returns a description of the entities that
have been modified by this function.
INTEGER <Return Value> This function returns a value of 0 when executed suc-
cessfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The string input value option can have the following values:
Chapter 4: Finite Element Functions 1119
Equivalence Action
Value Description
init This option will save the display and erase all of the entities of
the selected type from the current viewport.
erase_all This option will erase all of the entities of the selected type from
the current viewport.
plot_all This option will plot all of the saved entities of the selected type
in the current viewport.
free_edge This option will plot all of the saved entities of the selected type
associated to free edges.
free_face This option will plot all of the saved entities of the selected type
associated to free faces.
restore This option will restore the saved display.
Space is internally allocated for the string returned by the output value entity_selection. It is the
responsibility of the calling function to free the allocated string storage space.
Example:
Description:
This function will provide a preview of what happens if the selected nodes that coexist at a single point
are reduced to a single node. This function is similar to the fem_equiv_list3() function except that no
nodes will be deleted; they will only be displayed and marked on the screen.
Input:
STRING node_select[] This value specifies a selection of node identifiers
defining the nodes to be reduced.
STRING exclude_select[] This value specifies a selection of node identifiers
defining the nodes to be excluded from the reduction
process.
INTEGER tolerance_type This value specifies the type of tolerance geometry
that will be used to reduce nodes. All nodes that fit in
the tolerance region will be reduced to a single node.
A cubic tolerance geometry will be used if this value
is set to 1 and a spherical tolerance geometry will be
used if this value is set to 2.
REAL tolerance This value specifies the size of the tolerance region.
This value must greater than zero.
INTEGER entity_type This value specifies the entity type for which the dis-
play will be modified. This argument can have the
following values: 0 = both nodes and elements, 1 =
nodes, and 2 = elements.
Output:
REAL updated_tolerance This value returns the size of the tolerance region, re-
calculated to prevent the collapse of element edges.
The input value tolerance is used as the starting value
for the algorithm used to calculate this value.
INTEGER segment_id This value returns the segment id for the graphics
segment that needs to be cleared. This value will be
set to -1 if the graphics segment has already been
cleared.
STRING nodes_previewed[VIRTUAL]
This value returns a description of the nodes that
have been previewed.
STRING elements_previewed[VIRTUAL]
Chapter 4: Finite Element Functions 1121
Equivalence Action
Remarks:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics
segment identifiers.
Space is internally allocated for the string returned by the output values nodes_reduced and
elements_reduced. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Optimize Action
This section is used to describe some of the functions used to optimize entities in a finite element model.
The optimization process will renumber the nodes or elements of a model in such a way that the stiffness
matrix assembled in a finite element analysis can be solved by using a minimum of CPU time, memory,
and disk space.
Chapter 4: Finite Element Functions 1123
Optimize Action
Description:
This function will renumber the nodes or elements in the model to minimize the time required to find
a finite element solution.
Input:
STRING object[8] This value specifies the type of entity to optimize. This ar-
gument can have the following values: Nodes or Ele-
ments.
STRING method[] This value specifies the type of optimization method used.
This argument can have the following values: C =
Cuthill-McKee method, G = Gibbs-Poole-Stock-
meyer, or B = both methods.
STRING criterion[] This value specifies the minimization criterion used by the
optimization process. This argument can have the follow-
ing values: RMS Wavefront, Bandwidth, Max
Wavefront, or Profile.
INTEGER starting_id This value specifies the id at which to start the renumber-
ing process.
Output:
INTEGER bandwidth(4) This value returns the bandwidth calculated both before
and after the optimization process is done. See the re-
marks listed below for a description of the use of each off-
set.
INTEGER profile(4) This value returns the profile calculated both before and
after the optimization process is done. See the remarks
listed below for a description of the use of each offset.
INTEGER maximum_wavefront(4)
This value returns the maximum wavefront value calcu-
lated both before and after the optimization process is do-
ne. See the remarks listed below for a description of the
use of each offset.
REAL avgerage_wavefront(4)
This value returns the minimum wavefront value calculat-
ed both before and after the optimization process is done.
See the remarks listed below for a description of the use
of each offset.
1124 PCL Reference Manual
Optimize Action
REAL rms_wavefront(4) This value returns the root mean squared wavefront value
calculated both before and after the optimization process
is done. See the remarks listed below for a description of
the use of each offset.
INTEGER <Return Value> This function returns a value of 0 when executed success-
fully and a non zero value to indicate a change in status or
an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The offsets in the returned values bandwidth, profile, maximum_wavefront, average_wavefront, and
rms_wavefront have the following uses:
Chapter 4: Finite Element Functions 1125
Optimize Action
1 Cuthill-McKee This offset will list the value calculated when the
Cuthill-McKee method is selected but before the opti-
mization process takes place.
2 Cuthill-McKee This offset will list the value calculated when the
Cuthill-McKee method is selected but after the optimi-
zation process takes place.
1 Gibbs-Poole-Stockmeyer This offset will list the value calculated when the
Gibbs-Poole-Stockmeyer method is selected but be-
fore the optimization process takes place.
2 Gibbs-Poole-Stockmeyer This offset will list the value calculated when the
Gibbs-Poole-Stockmeyer method is selected but after
the optimization process takes place.
1 Both This offset will list the value calculated when the
Cuthill-McKee method is selected but before the opti-
mization process takes place.
2 Both This offset will list the value calculated when the
Cuthill-McKee method is selected but after the optimi-
zation process takes place.
3 Both This offset will list the value calculated when the
Gibbs-Poole-Stockmeyer method is selected but be-
fore the optimization process takes place.
4 Both This offset will list the value calculated when the
Gibbs-Poole-Stockmeyer method is selected but after
the optimization process takes place.
This function will update the current viewport to reflect the renumbering of the optimized nodes and
elements.
Example:
Verify Action
This section is used to describe some of the functions used to verify entities in a finite element model.
The verification of a finite element model consists of a number of different tests which can be performed
to check the validity of a finite element model. These tests include checks of element distortion, element
duplication, model boundaries, nodal connectivity, and node and element identifier numbering.
Chapter 4: Finite Element Functions 1127
Verify Action
Description:
This function will verify spot weld connector inputs.
Input:
STRING[] method The connector creation method (Projection or Axis).
STRING[] fmt The fastener format (PROP or ELEM).
REAL diameter The connector diameter.
STRING[] gs List of connector locations (nodes or xyz).
STRING[] ga List of surface A pierce nodes.
STRING[] gb List of surface B pierce nodes.
STRING[] pata List of surface A patch identifiers.
STRING[] patb List of surface B patch identifiers.
Output:
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
MSG_FEM_CONN_ZERO_DIAM
MSG_FEM_CONN_GS_OR_GA_REQD
MSG_FEM_CONN_ALIGN_GA_GB_REQD
MSG_FEM_CONN_PATA_PATB_REQD
MSG_FEM_CONN_BAD_POINT_PATCH
MSG_FEM_CONN_GS_NODE_ID_REQD
MSG_FEM_CONN_PROP_NOT_FOUND
Description:
This function will verify spot weld connector inputs.
Input:
STRING[] method The connector creation method (Projection or Axis).
STRING[] fmt The weld format (ELPAT, PARTPAT, ALIGN,
ELEMID, or GRIDID).
REAL diameter The spot weld diameter.
STRING[] gs List of connector locations (nodes or xyz).
1128 PCL Reference Manual
Verify Action
Description:
This function will display a graphics table of the results of an element verification procedure. It will
make use of a threshold value to identify elements that have failed.
Input:
STRING group_name[31] This value specifies the label of the group to which the
results will be assigned.
INTEGER table_id This value specifies the id for a graphic table that will
be assigned to the group specified by the input value
group_name.
REAL best_value This value specifies the best value in the graphic table.
REAL worst_value This value specifies the worst value in the graphic table.
REAL threshold This value specifies the threshold for all elements that
have failed the verification process. Any entry with a
value greater than the threshold value will be shown as
an element that has failed.
STRING render_style[31] This value specifies the render style assigned to each
element. This value should be set to ELEMFILL. See
the remarks below for a table of allowed values.
Output:
None.
Error Conditions:
None.
Remarks:
This function will assign a table of verification results to either a group or to all of the entities in the model
depending on the display method that has been set.
The input value render_style can have the following values:
1130 PCL Reference Manual
Verify Action
Render Style
Example:
Description:
This function will display a graphics table of the results of an element verification procedure without
the use of a threshold value.
Input:
STRING group_name[31] This value specifies the label of the group to which the
results will be assigned.
INTEGER table_id This value specifies the id for a graphic table that will be
assigned to the group specified by the input value
group_name.
REAL minimum_value This value specifies the minimum value in the graphic
table.
REAL maximum_value This value specifies the maximum value in the graphic
table.
STRING render_style[31] This value specifies the render style assigned to each
element. This value should be set to ELEMFILL. See
the remarks below for a table of allowed values.
Output:
None.
Error Conditions:
None.
Remarks:
This function will assign a table of verification results to either a group or to all of the entities in the model
depending on the display method that has been set.
The input value render_style can have the following values:
Chapter 4: Finite Element Functions 1131
Verify Action
Render Style
Example:
Description:
This function will display the entities that have failed an element verification procedure as a high
lighted wireframe.
Input:
STRING option[] This value specifies the type of plot to be
displayed: plot_failed to plot only the elements
that have failed the verification process and are
members of the current group, or restore to
restore the original viewport display.
INTEGER table_id This value specifies the id for a graphics table that
will be assigned to the current group.
REAL threshold This value specifies the threshold for all elements
that will be colored as elements that have failed the
verification process.
Output:
STRING entities_failed [VIRTUAL]
This value will return a description of the elements
in the current group that have failed the element
verification process when the input value option is
set to plot_failed. If the input value option is not
set to plot_failed this value will return the initial
value set by the calling function.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
None.
Remarks:
This function will return a value of zero and will do nothing if the input value option is not set to either
plot_failed or restore.
Space is internally allocated for the string returned by the output value entities_failed when the input
value option is set to plot_failed. It is the responsibility of the calling function to free the allocated
string storage space.
Example:
fem_verify_draw_normal_vectors (segment_id)
Description:
This function will draw normal vectors on all shell or surface elements in the current group.
Input:
INTEGER segment_id This value specifies the graphics segment id for
the graphics segment in which the normal vectors
will be drawn.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
None.
Remarks:
See the description for the function gm_segment_create() in the PCL Customization manual for more
information on the use of graphics segments.
Example:
Description:
This function will load the graphic display tables with the id values of all of the elements in the
current group as scalar results values.
Input:
None.
Output:
STRING group_name[31] This value will return a description of the group to
which the id value information has been applied.
REAL minimum_value This value will return the minimum id value.
INTEGER minimum_id This value will return the id of the element with the
minimum id value.
REAL maximum_value This value will return the maximum id value.
INTEGER maximum_id This value will return the id of the element with the
maximum id value.
INTEGER table_id This value returns the id for the table of element id
values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Element, and the test is set to IDs.
Use the fem_verify_ids_display() function to display the graphics display tables produced by this
function.
Example:
Description:
This function will test solid elements for proper connectivity.
Input:
LOGICAL reverse This value specifies, when set to TRUE, that any
elements that are found with a negative volume
should be reversed so that the volume is positive.
When this value is set to false, elements will be
allowed to retain negative volume values.
Output:
STRING entities_failed [VIRTUAL]
This value will return a description of the
elements in the current group that have failed the
element verification process.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Element, and the test is set to Connectivity.
Space is internally allocated for the string returned by the output value entities_failed. It is the
responsibility of the calling function to free the allocated string storage space.
Example:
Description:
This function will load the graphic display tables with the Jacobian ratio values of all of the elements
in the current group.
Input:
None.
Output:
STRING group_name[31] This value will return a description of the group
to which the Jacobian ratio information has been
applied.
REAL minimum_value This value will return the minimum Jacobian
ratio value.
INTEGER minimum_id This value will return the id of the element with
the minimum Jacobian ratio value.
REAL maximum_value This value will return the maximum Jacobian
ratio value.
INTEGER maximum_id This value will return the id of the element with
the maximum Jacobian ratio value.
INTEGER table_id This value returns the id for the table of element
Jacobian ratio values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Element, and the test is set to Jacobian Ratio.
Example:
Description:
This function will load the graphic display tables with the Jacobian zero values of all of the elements
in the current group.
Input:
None.
Output:
STRING group_name[31] This value will return a description of the group
to which the Jacobian zero information has
been applied.
REAL minimum_value This value will return the minimum Jacobian
zero value.
INTEGER minimum_id This value will return the id of the element with
the minimum Jacobian zero value.
REAL maximum_value This value will return the maximum Jacobian
zero value.
INTEGER maximum_id This value will return the id of the element with
the maximum Jacobian zero value.
INTEGER table_id This value returns the id for the table of element
Jacobian zero values.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Element, and the test is set to Jacobian Zero.
Example:
Description:
Check the entire database for duplicate elements and optionally delete them.
Input:
LOGICAL delete_elements This value specifies, when set to TRUE, that any
duplicate elements will be deleted. When this value is
set to FALSE, duplicate elements will not be deleted.
LOGICAL delete_high This value specifies, when set to TRUE, that the
elements with the higher identifier values will be
deleted from sets of duplicate elements. If this value is
set to FALSE, the duplicate elements with the lower
identifier values will be deleted from sets of duplicate
elements. Duplicate elements will be deleted only when
the input value delete_elements is set to TRUE.
Output:
INTEGER num_duplicates This value returns the number of duplicate elements
that where found.
STRING kept_elements[VIRTUAL]
This value returns a description of the elements that
where not deleted by the verification process.
STRING deleted_elements[VIRTUAL]
This value returns a description of the elements that
where deleted by the verification process.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Element, and the test is set to Duplicates.
Space is internally allocated for the string returned by the output values kept_elements and
deleted_elements. It is the responsibility of the calling function to free the allocated string storage space.
Chapter 4: Finite Element Functions 1139
Verify Action
Example:
Description:
This function will verify the direction of the normal vectors for all shell elements in the current group.
Input:
LOGICAL reverse_elements This value specifies, when set to TRUE, that reversed
normals be flipped to match the direction specified by the
input value guide_element.
LOGICAL color_code This value specifies, when set to TRUE, that a results
table to be used for the element color coding to be
created.
STRING guide_element[] This value specifies the id for an element that is used to
define the desired normal direction.
Output:
STRING group_name[31] This value will return a description of the group to which
the normal vector information has been applied.
INTEGER table_id This value returns the id for the table of element normal
vector values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Element, and the test is set to Normals.
This function will not draw any normal vectors in the viewport.
Example:
Description:
This function will retrieve the graphics display settings that can be used to restore the graphics display
to its original state.
Input:
None.
Output:
INTEGER display_method This value returns the display method value: 1 =
entities, or 2 = groups.
STRING group_name[31] This value returns the name of the current group.
STRING render_style[31] This value returns the render style. See the remarks
below for a table of allowed values.
STRING viewport_name[31 This value returns the name of the current viewport.
]
INTEGER spectrum_setting This value returns TRUE or 1 if the current spectrum
settings are posted to the current viewport and FALSE
or 0 otherwise.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
See the description for the function fem_verify_reset_graphics() for more information.
The returned value render_style can have the following values:
Render Style
Example:
Description:
This function will run all of the verification tests for all hexagonal elements in the current group and
highlight any elements that fail the tests.
Input:
REAL threshold(10) This value specifies the threshold comparison value for
all of the tests. See the remarks for a description of the
use of each offset in this array.
Output:
INTEGER num_failures(10) This value returns the number of elements that have
failed a test. See the remarks for a description of the use
of each offset in this array.
REAL worst_value(10) This value returns the value for the worst case value of
each test. See the remarks for a description of the use of
each offset in this array.
INTEGER worst_id(10) This value returns the id for the worst case element of
each test. See the remarks for a description of the use of
each offset in this array.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Hex, and the test is set to All.
The real input value threshold uses the offsets in the array to specify the test failure threshold values for
the following finite model attributes:
1142 PCL Reference Manual
Verify Action
Offset Description
1 The aspect ratio or the length/height of the element with a range of 0 to 20.
2 The edge angle of the element with a range of 0 to 90 degrees.
3 The face skew angle of the element with a range of 0 to 90 degrees.
4 The face warp angle of the element with a range of 0 to 90 degrees.
5 The element twist angle with a range of 0 to 90 degrees.
6 The face taper value ranging from 0 to 1.
7 The normal offset value.
8 The tangent offset value.
9 Not used.
10 Not used.
The output values num_failures, worst_value, and worst_id all use array offsets in the in the following
manner:
Offset Description
Example:
Description:
This function will load the graphic display tables with the aspect ratio values of all of the hexagonal
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the aspect
ratio values loaded into the graphic display table are
calculated using this formula: 1 - width / length. The
standard aspect ratio values are calculated when this
value is set to FALSE using this formula: length /
width.
REAL threshold This value specifies the threshold of failure
comparison value. When the input value normalize is
set to TRUE, this value must be greater than 0.0 and
equal to or less than 1.0. When the input value
normalize is set to FALSE, this value must be greater
than 0.0 and less than or equal to 1.0 E +10.
Output:
STRING group_name[31] This value will return a description of the group to
which the test has been applied.
REAL minimum_value This value will return the minimum aspect ratio value.
INTEGER minimum_id This value will return the id of the element with the
minimum aspect ratio value.
REAL maximum_value This value will return the maximum aspect ratio value.
INTEGER maximum_id This value will return the id of the element with the
maximum aspect ratio value.
INTEGER table_id This value returns the id for the table of element aspect
ratio values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Hex, and the test is set to Aspect.
1144 PCL Reference Manual
Verify Action
This function will write the element number and the aspect ratio value for each element in the current
group that has exceeded the threshold value to the history window.
This function can display a percent complete popup form.
Example:
Description:
This function will load the graphic display tables with the edge angle values of all of the hexagonal
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the edge
angle values loaded into the graphic display table are
calculated using this formula: (90.0 - interior angle) /
90.0. The standard edge angle values are calculated
when this value is set to FALSE using this formula:
90.0 - interior angle.
REAL threshold This value specifies the threshold of failure
comparison value. When the input value normalize is
set to TRUE, this value must be greater than 0.0 and
equal to or less than 1.0. When the input value
normalize is set to FALSE, this value must be greater
than 0.0 and less than or equal to 120.0.
Output:
STRING group_name[31] This value will return a description of the group to
which the test has been applied.
REAL minimum_value This value will return the minimum edge angle value.
INTEGER minimum_id This value will return the id of the element with the
minimum edge angle value.
REAL maximum_value This value will return the maximum edge angle value.
INTEGER maximum_id This value will return the id of the element with the
maximum edge angle value.
INTEGER table_id This value returns the id for the table of element edge
angle values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
1146 PCL Reference Manual
Verify Action
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Hex, and the test is set to Edge Angle.
Example:
Please see fem_verify_hex_edangle (p. 829) in the PCL Reference Manual Examples.
Chapter 4: Finite Element Functions 1147
Verify Action
Description:
This function will load the graphic display tables with the face skew values of all of the hexagonal
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the face skew
values loaded into the graphic display table are calculated
using this formula: (90.0 - interior angle) / 90.0. The
standard face skew values are calculated when this value
is set to FALSE using this formula: 90.0 - interior angle.
REAL threshold This value specifies the threshold of failure comparison
value. When the input value normalize is set to TRUE, this
value must be greater than 0.0 and equal to or less than 1.0.
When the input value normalize is set to FALSE, this value
must be greater than 0.0 and less than or equal to 90.0.
Output:
STRING group_name[31] This value will return a description of the group to which
the test has been applied.
REAL minimum_value This value will return the minimum face skew value.
INTEGER minimum_id This value will return the id of the element with the
minimum face skew value.
REAL maximum_value This value will return the maximum face skew value.
INTEGER maximum_id This value will return the id of the element with the
maximum face skew value.
INTEGER table_id This value returns the id for the table of element face skew
values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Hex, and the test is set to Face Skew.
1148 PCL Reference Manual
Verify Action
Example:
Description:
This function will load the graphic display tables with the face taper values of all of the hexagonal
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the face taper
values loaded into the graphic display table are calculated using
this formula: (90.0 - interior angle) / 90.0. The standard face
taper values are calculated when this value is set to FALSE
using this formula: 90.0 - interior angle.
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value must
be greater than 0.0 and equal to or less than 1.0. When the input
value normalize is set to FALSE, this value must be greater than
0.0 and less than or equal to 2147483600.0.
Output:
STRING group_name[31] This value will return a description of the group to which the test
has been applied.
REAL minimum_value This value will return the minimum face taper value.
INTEGER minimum_id This value will return the id of the element with the minimum
face taper value.
REAL maximum_value This value will return the maximum face taper value.
INTEGER maximum_id This value will return the id of the element with the maximum
face taper value.
INTEGER table_id This value returns the id for the table of element face taper
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Chapter 4: Finite Element Functions 1149
Verify Action
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Hex, and the test is set to Face Taper.
Example:
Description:
This function will load the graphic display tables with the face warp values of all of the hexagonal
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the face warp
values loaded into the graphic display table are calculated using
this formula: (interior angle) / 15.0. The standard face warp
values are calculated when this value is set to FALSE using this
formula: interior angle.
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value must
be greater than 0.0 and equal to or less than 1.0. When the input
value normalize is set to FALSE, this value must be greater than
0.0 and less than or equal to 90.0.
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum face warp value.
INTEGER minimum_id This value will return the id of the element with the minimum
face warp value.
REAL maximum_value This value will return the maximum face warp value.
INTEGER maximum_id This value will return the id of the element with the maximum
face warp value.
INTEGER table_id This value returns the id for the table of element face warp
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Hex, and the test is set to Face Warp.
Chapter 4: Finite Element Functions 1151
Verify Action
Example:
Description:
This function will load the graphic display tables with the twist values of all of the hexagonal elements
in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the twist values
loaded into the graphic display table are calculated using this
formula: (interior angle) / 90.0. The standard twist values are
calculated when this value is set to FALSE using this formula:
interior angle.
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value must
be greater than 0.0 and equal to or less than 1.0. When the input
value normalize is set to FALSE, this value must be greater than
0.0 and less than or equal to 90.0.
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum twist value.
INTEGER minimum_id This value will return the id of the element with the minimum
twist value.
REAL maximum_value This value will return the maximum twist value.
INTEGER maximum_id This value will return the id of the element with the maximum
twist value.
INTEGER table_id This value returns the id for the table of element twist values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Hex, and the test is set to Twist.
1152 PCL Reference Manual
Verify Action
Example:
Description:
This function will load the graphic display tables with the midnode normal offset values of all of the
elements in the current group.
Input:
REAL threshold This value specifies the threshold of failure comparison value.
This value must be greater than 0.0 and equal to or less than 1.0.
Output:
STRING group_name[31] This value will return a description of the group to which the test
has been applied.
REAL minimum_value This value will return the minimum normal offset value.
INTEGER minimum_id This value will return the id of the element with the minimum
normal offset value.
REAL maximum_value This value will return the maximum normal offset value.
INTEGER maximum_id This value will return the id of the element with the maximum
normal offset value.
INTEGER table_id This value returns the id for the table of normal element offset
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Midnode, and the test is set to Normal Offset.
Example:
Description:
This function will load the graphic display tables with the midnode tangent offset values of all of the
elements in the current group.
Input:
REAL threshold This value specifies the threshold of failure comparison
value. This value must be greater than 0.0 and equal to or less
than 1.0.
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum tangent offset value.
INTEGER minimum_id This value will return the id of the element with the
minimum tangent offset value.
REAL maximum_value This value will return the maximum tangent offset value.
INTEGER maximum_id This value will return the id of the element with the
maximum tangent offset value.
INTEGER table_id This value returns the id for the table of tangent element
offset values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Midnode, and the test is set to Tangent Offset.
Example:
Description:
This function will load the graphic display tables with the id values of all of the nodes in the current
group as scalar results values.
Input:
None.
Output:
STRING group_name[31] This value will return a description of the group to which the id
value information has been applied.
REAL minimum_value This value will return the minimum id value.
INTEGER minimum_id This value will return the id of the element with the minimum id
value.
REAL maximum_value This value will return the maximum id value.
INTEGER maximum_id This value will return the id of the element with the maximum id
value.
INTEGER table_id This value returns the id for the table of element id values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Node, and the test is set to Ids.
Example:
Description:
This function will run all of the verification tests for all quadrilateral elements in the current group
and highlight any elements that fail the tests.
Input:
REAL threshold(8) This value specifies the threshold comparison value for
all of the tests. See the remarks for a description of the
use of each offset in this array.
Output:
INTEGER num_failures(8) This value returns the number of elements that have
failed a test. See the remarks for a description of the use
of each offset in this array.
REAL worst_value(8) This value returns the value for the worst case value of
each test. See the remarks for a description of the use of
each offset in this array.
INTEGER worst_id(8) This value returns the id for the worst case element of
each test. See the remarks for a description of the use of
each offset in this array.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Quad, and the test is set to All.
The input value threshold and the output value num_failures both use the values at the following offsets
for the following finite element model attributes:
1156 PCL Reference Manual
Verify Action
Offset Description.
The output values worst_value and worst_id both use the values at the following offsets to return
information about the following finite element model attributes
:
Offset Description.
Example:
Description
:
This function will load the graphic display tables with the aspect ratio values of all of the quadrilateral
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the aspect ratio values
loaded into the graphic display table are calculated using this
formula: (1 - (h2 / h1)). The standard aspect ratio values are
calculated when this value is set to FALSE using this formula: (h1
/ h2).
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value must be
greater than 0.0 and equal to or less than 1.0. When the input value
normalize is set to FALSE, this value must be greater than 0.0 and
less than or equal to 2147483600.0.
LOGICAL split This value specifies, when set to TRUE, that each quadrilateral
element that fails the test will be deleted and replaced with two
quadrilateral elements that split the original element across its
longer dimension.
Output:
STRING group_name[31] This value will return a description of the group to which the test
has been applied.
REAL minimum_value This value will return the minimum aspect ratio value.
INTEGER minimum_id This value will return the id of the element with the minimum
aspect ratio value.
REAL maximum_value This value will return the maximum aspect ratio value.
INTEGER maximum_id This value will return the id of the element with the maximum
aspect ratio value.
STRING created_elements[VIRTUAL]
This value returns a description of any elements that have been
created by this function.
STRING created_nodes[VIRTUAL]
This value returns a description of any nodes that have been
created by this function.
1158 PCL Reference Manual
Verify Action
INTEGER table_id This value returns the id for the table of element aspect ratio
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Quad, and the test is set to Aspect.
This function will list the element number, the aspect ratio value, and the threshold value for every
element whose aspect ratio exceeds the threshold value in the history window.
Space is internally allocated for the string returned by the output values created_elements and
created_nodes. It is the responsibility of the calling function to free the allocated string storage space.
This function can display a percent complete popup form.
Example:
Description:
This function will load the graphic display tables with the skew angle values of all of the quadrilateral
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the skew angle
values loaded into the graphic display table are calculated using
this formula: ((90.0 - interior angle) / 90.0). The standard skew
angle values are calculated when this value is set to FALSE using
this formula: (90.0 - interior angle).
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value must
be greater than 0.0 and equal to or less than 1.0. When the input
value normalize is set to FALSE, this value must be greater than
0.0 and less than or equal to 90.0.
LOGICAL split This value specifies, when set to TRUE, that each quadrilateral
element that fails the test will be deleted and replaced with two
triangular elements that split the original element along its shorter
diagonal dimension.
Output:
STRING group_name[31] This value will return a description of the group to which the test
has been applied.
REAL minimum_value This value will return the minimum skew angle value.
INTEGER minimum_id This value will return the id of the element with the minimum
skew angle value.
REAL maximum_value This value will return the maximum skew angle value.
INTEGER maximum_id This value will return the id of the element with the maximum
skew angle value.
STRING created_elements[VIRTUAL]
This value returns a description of any elements that have been
created by this function.
STRING created_nodes[VIRTUAL]
This value returns a description of any nodes that have been
created by this function.
1160 PCL Reference Manual
Verify Action
INTEGER table_id This value returns the id for the table of element skew angle
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Quad, and the test is set to Skew.
This function will list the element number and the skew angle value for every element whose skew angle
exceeds the threshold value in the history window.
Space is internally allocated for the string returned by the output values created_elements and
created_nodes. It is the responsibility of the calling function to free the allocated string storage space.
This function can display a percent complete popup form.
Example:
Description
:
This function will load the graphic display tables with the taper angle values of all of the quadrilateral
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the taper angle
values loaded into the graphic display table are calculated using
this formula: (1- ((4.0 x interior angle) / quadrilateral area)). The
standard taper angle values are calculated when this value is set
to FALSE using this formula: ((4.0 x interior angle) /
quadrilateral area).
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value must
be greater than 0.0 and equal to or less than 1.0. When the input
value normalize is set to FALSE, this value must be greater than
0.0 and less than or equal to 1.0.
LOGICAL split This value specifies, when set to TRUE, that each quadrilateral
element that fails the test will be deleted and replaced with two
quadrilateral elements.
Output:
STRING group_name[31] This value will return a description of the group to which the test
has been applied.
REAL minimum_value This value will return the minimum taper angle value.
INTEGER minimum_id This value will return the id of the element with the minimum
taper angle value.
REAL maximum_value This value will return the maximum taper angle value.
INTEGER maximum_id This value will return the id of the element with the maximum
taper angle value.
STRING created_elements[VIRTUAL]
This value returns a description of any elements that have been
created by this function.
STRING created_nodes[VIRTUAL]
This value returns a description of any nodes that have been
created by this function.
1162 PCL Reference Manual
Verify Action
INTEGER table_id This value returns the id for the table of element taper angle
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Quad, and the test is set to Taper.
This function will list the element number, the taper angle value, and the threshold value for every
element whose taper angle exceeds the threshold value in the history window.
Space is internally allocated for the string returned by the output values created_elements and
created_nodes. It is the responsibility of the calling function to free the allocated string storage space.
This function can display a percent complete popup form.
Example:
Description
:
This function will load the graphic display tables with the warp angle values of all of the quadrilateral
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the warp angle
values loaded into the graphic display table are calculated using
this formula: (interior angle / 15.0). The standard warp angle
values are calculated when this value is set to FALSE using this
formula: (interior angle).
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value must
be greater than 0.0 and equal to or less than 1.0. When the input
value normalize is set to FALSE, this value must be greater than
0.0 and less than or equal to 90.0.
LOGICAL split This value specifies, when set to TRUE, that each quadrilateral
element that fails the test will be deleted and replaced with two
triangular elements.
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum warp angle value.
INTEGER minimum_id This value will return the id of the element with the minimum
warp angle value.
REAL maximum_value This value will return the maximum warp angle value.
INTEGER maximum_id This value will return the id of the element with the maximum
warp angle value.
STRING created_elements[VIRTUAL]
This value returns a description of any elements that have been
created by this function.
STRING created_nodes[VIRTUAL]
This value returns a description of any nodes that have been
created by this function.
1164 PCL Reference Manual
Verify Action
INTEGER table_id This value returns the id for the table of element warp angle
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Quad, and the test is set to Warp.
This function will list the element number and the warp angle value for every element whose warp angle
exceeds the threshold value in the history window.
Space is internally allocated for the string returned by the output values created_elements and
created_nodes. It is the responsibility of the calling function to free the allocated string storage space.
This function can display a percent complete popup form.
Example:
Description:
This function can be used to reset graphics parameters after the results of a finite element verification
operation has been displayed in a viewport.
Input:
STRING render_style[31] This value specifies the original render style. This value
will either be applied to the group named in the input value
group_name or to all of the entities in the model,
depending on the current display method setting. See the
remarks below for a table of allowed values.
STRING group_name[31] This value specifies the original group name to which the
render style will be applied.
INTEGER spectrum_set This value specifies the original spectrum setting which, if
set to TRUE or 1, will indicate that the current spectrum
settings are posted to the viewport. This value can be set to
FALSE or 0 to indicate that the current spectrum settings
are not posted to the viewport.
STRING viewport_name[31] This value specifies the original viewport name to which
the input value spectrum_set will be applied.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Remarks:
See the description for the function fem_verify_get_graphset() for more information.
Setting the input value spectrum_set to TRUE or 1 will not post the current spectrum settings to a
viewport, it will just place a setting in the database to indicate the post status of the spectrum settings.
The returned value render_style can have the following values:
1166 PCL Reference Manual
Verify Action
Render Style
Example:
Description:
This function will run all of the verification tests for all tetrahedral elements in the current group
and highlight any elements that fail the tests.
Input:
REAL threshold(8) This value specifies the threshold comparison values
for all tests.
Output:
INTEGER num_failures(8) This value returns the number of elements failing the
tests.
REAL worst_value(8) This value returns the value at which worst case
occurred.
INTEGER worst_id(8) This value returns the identifiers for the worst case
elements that have failed the tests.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Tet, and the test is set to All.
The input value threshold and the output value num_failures both use the values at the following offsets
for the following finite element model attributes:
Chapter 4: Finite Element Functions 1167
Verify Action
Offset Description.
The output values worst_value and worst_id both use the values at the following offsets to return
information about the following finite element model attributes:
Offset Description.
Example:
Description:
This function will load the graphic display tables with the aspect ratio values of all of the tetrahedral
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the aspect ratio
values loaded into the graphic display table are calculated
using a normalization formula.
REAL threshold This value specifies the threshold of failure comparison
value. When the input value normalize is set to TRUE, this
value must be greater than 0.0 and equal to or less than 1.0.
When the input value normalize is set to FALSE, this value
must be greater than 0.0 and less than or equal to 1.0 E +10.
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum aspect ratio value.
INTEGER minimum_id This value will return the id of the element with the minimum
aspect ratio value.
REAL maximum_value This value will return the maximum aspect ratio value.
INTEGER maximum_id This value will return the id of the element with the
maximum aspect ratio value.
INTEGER table_id This value returns the id for the table of element aspect ratio
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Tet, and the test is set to Aspect.
This function will write the element number and the aspect ratio value for each element in the current
group that has exceeded the threshold value to the history window.
This function can display a percent complete popup form.
Chapter 4: Finite Element Functions 1169
Verify Action
Example:
Description:
This function will load the graphic display tables with the collapse values of all of the tetrahedral
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the collapse
values loaded into the graphic display table are calculated
using a normalization formula.
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value
must be greater than 0.0 and equal to or less than 1.0. When the
input value normalize is set to FALSE, this value must be
greater than 0.0 and less than or equal to 1.0 E +10.
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum collapse value.
INTEGER minimum_id This value will return the id of the element with the minimum
collapse value.
REAL maximum_value This value will return the maximum collapse value.
INTEGER maximum_id This value will return the id of the element with the maximum
collapse value.
INTEGER table_id This value returns the id for the table of element collapse
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Tet, and the test is set to Collapse.
1170 PCL Reference Manual
Verify Action
This function will write the element number and the collapse value for each element in the current group
that has exceeded the threshold value to the history window.
This function can display a percent complete popup form.
Example:
Description:
This function will load the graphic display tables with the edge angle values of all of the tetrahedral
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the edge angle
values loaded into the graphic display table are calculated
using a normalization formula.
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value
must be greater than 0.0 and equal to or less than 1.0. When the
input value normalize is set to FALSE, this value must be
greater than 0.0 and less than or equal to 1.0 E +10.
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum edge angle value.
INTEGER minimum_id This value will return the id of the element with the minimum
edge angle value.
REAL maximum_value This value will return the maximum edge angle value.
INTEGER maximum_id This value will return the id of the element with the maximum
edge angle value.
INTEGER table_id This value returns the id for the table of element edge angle
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Tet, and the test is set to Edge Angle.
This function will write the element number and the edge angle value for each element in the current
group that has exceeded the threshold value to the history window.
1172 PCL Reference Manual
Verify Action
Description:
This function will load the graphic display tables with the face skew values of all of the tetrahedral
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the face skew
values loaded into the graphic display table are calculated
using a normalization formula.
REAL threshold This value specifies the threshold of failure comparison
value. When the input value normalize is set to TRUE, this
value must be greater than 0.0 and equal to or less than 1.0.
When the input value normalize is set to FALSE, this value
must be greater than 0.0 and less than or equal to 90.0.
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum face skew value.
INTEGER minimum_id This value will return the id of the element with the
minimum face skew value.
REAL maximum_value This value will return the maximum face skew value.
INTEGER maximum_id This value will return the id of the element with the
maximum face skew value.
INTEGER table_id This value returns the id for the table of element face skew
values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Chapter 4: Finite Element Functions 1173
Verify Action
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Tet, and the test is set to Edge Angle.
This function will write the element number and the face skew value for each element in the current group
that has exceeded the threshold value to the history window.
This function can display a percent complete popup form.
Example:
Description:
This function will run all of the verification tests for all triangular elements in the current group an
highlight any elements that fail the tests.
Input:
REAL threshold(6) This value specifies the threshold comparison value for all of
the tests. See the remarks for a description of the use of each
offset in this array.
Output:
INTEGER num_failures(6) This value returns the number of elements that have failed a
test. See the remarks for a description of the use of each offset
in this array.
REAL worst_value(6) This value returns the value for the worst case value of each
test. See the remarks for a description of the use of each offset
in this array.
INTEGER worst_id(6) This value returns the id for the worst case element of each
test. See the remarks for a description of the use of each offset
in this array.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Tria, and the test is set to All.
1174 PCL Reference Manual
Verify Action
The input value threshold and the output value num_failures both use the values at the following offsets
for the following finite element model attributes.
:
Offset Description.
The output values worst_value and worst_id both use the values at the following offsets to return
information about the following finite element model attributes
:
Offset Description.
Example:
Description:
This function will load the graphic display tables with the aspect ratio values of all of the triangular
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the aspect ratio
values loaded into the graphic display table are calculated
using a normalization formula.
REAL threshold This value specifies the threshold of failure comparison
value. When the input value normalize is set to TRUE, this
value must be greater than 0.0 and equal to or less than 1.0.
When the input value normalize is set to FALSE, this value
must be greater than 0.0 and less than or equal to 90.0.
Output:
STRING group_name[31] This value will return a description of the group to which
the test has been applied.
REAL minimum_value This value will return the minimum aspect ratio value.
INTEGER minimum_id This value will return the id of the element with the
minimum aspect ratio value.
REAL maximum_value This value will return the maximum aspect ratio value.
INTEGER maximum_id This value will return the id of the element with the
maximum aspect ratio value.
INTEGER table_id This value returns the id for the table of element aspect ratio
values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Tria, and the test is set to Aspect.
This function will write the element number, the aspect ratio value for each element in the current group
that has exceeded the threshold value, and the threshold value to the history window.
1176 PCL Reference Manual
Verify Action
Description:
This function will load the graphic display tables with the skew angle values of all of the triangular
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the skew angle
values loaded into the graphic display table are calculated
using a normalization formula.
REAL threshold This value specifies the threshold of failure comparison
value. When the input value normalize is set to TRUE, this
value must be greater than 0.0 and equal to or less than 1.0.
When the input value normalize is set to FALSE, this value
must be greater than 0.0 and less than or equal to 90.0.
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum skew angle value.
INTEGER minimum_id This value will return the id of the element with the minimum
skew angle value.
REAL maximum_value This value will return the maximum skew angle value.
INTEGER maximum_id This value will return the id of the element with the maximum
skew angle value.
INTEGER table_id This value returns the id for the table of element skew angle
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Tria, and the test is set to Skew.
Chapter 4: Finite Element Functions 1177
Verify Action
This function will write the element number, the skew angle value for each element in the current group
that has exceeded the threshold value, and the threshold value to the history window.
This function can display a percent complete popup form.
Example:
Description:
This function will run all of the verification tests for all wedge elements in the current group an
highlight any elements that fail the tests.
Input:
REAL threshold(10) This value specifies the threshold comparison value for all of
the tests. See the remarks for a description of the use of each
offset in this array.
Output:
INTEGER num_failures(10) This value returns the number of elements that have failed a
test. See the remarks for a description of the use of each offset
in this array.
REAL worst_value(10) This value returns the value for the worst case value of each
test. See the remarks for a description of the use of each offset
in this array.
INTEGER worst_id(10) This value returns the id for the worst case element of each
test. See the remarks for a description of the use of each offset
in this array.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Wedge, and the test is set to All.
The real input value threshold uses the offsets in the array to specify the test failure threshold values for
the following finite model attributes:
1178 PCL Reference Manual
Verify Action
Offset Description
1 The aspect ratio or the length/height of the element with a range of 0 to 20.
2 The edge angle of the element with a range of 0 to 90 degrees.
3 The face skew angle of the element with a range of 0 to 90 degrees.
4 The face warp angle of the element with a range of 0 to 90 degrees.
5 The element twist angle with a range of 0 to 90 degrees.
6 The face taper value ranging from 0 to 1.
7 The normal offset value.
8 The tangent offset value.
9 Not used.
10 Not used.
The output values num_failures, worst_value, and worst_id all use array offsets in the in the following
manner:
Offset Description
Example:
Description:
This function will load the graphic display tables with the aspect ratio values of all of the wedge
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the aspect ratio
values loaded into the graphic display table are calculated
using a normalization formula.
REAL threshold This value specifies the threshold of failure comparison
value. When the input value normalize is set to TRUE, this
value must be greater than 0.0 and equal to or less than 1.0.
When the input value normalize is set to FALSE, this value
must be greater than 0.0 and less than or equal to 10.0 E
+10.
Output:
STRING group_name[31] This value will return a description of the group to which
the test has been applied.
REAL minimum_value This value will return the minimum aspect ratio value.
INTEGER minimum_id This value will return the id of the element with the
minimum aspect ratio value.
REAL maximum_value This value will return the maximum aspect ratio value.
INTEGER maximum_id This value will return the id of the element with the
maximum aspect ratio value.
INTEGER table_id This value returns the id for the table of element aspect ratio
values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Wedge, and the test is set to Aspect.
This function will write the element number and the aspect ratio value for each element in the current
group that has exceeded the threshold value to the history window.
This function can display a percent complete popup form.
Example:
Description:
This function will load the graphic display tables with the face edge angle values of all of the wedge
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the face edge angle
values loaded into the graphic display table are calculated using
a normalization formula.
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value must
be greater than 0.0 and equal to or less than 1.0. When the input
value normalize is set to FALSE, this value must be greater than
0.0 and less than or equal to 120.0
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum face edge angle value.
INTEGER minimum_id This value will return the id of the element with the minimum
face edge angle value.
REAL maximum_value This value will return the maximum face edge angle value.
INTEGER maximum_id This value will return the id of the element with the maximum
face edge angle value.
INTEGER table_id This value returns the id for the table of element face edge angle
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Wedge, and the test is set to Edge Angle.
1182 PCL Reference Manual
Verify Action
This function will write the element number and the face edge angle value for each element in the current
group that has exceeded the threshold value to the history window.
This function can display a percent complete popup form.
Example:
Description:
This function will load the graphic display tables with the face skew angle values of all of the wedge
elements in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the face skew
angle values loaded into the graphic display table are calculated
using a normalization formula.
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value must
be greater than 0.0 and equal to or less than 1.0. When the input
value normalize is set to FALSE, this value must be greater than
0.0 and less than or equal to 90.0
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum face skew angle value.
INTEGER minimum_id This value will return the id of the element with the minimum
face skew angle value.
REAL maximum_value This value will return the maximum face skew angle value.
INTEGER maximum_id This value will return the id of the element with the maximum
face skew angle value.
INTEGER table_id This value returns the id for the table of element face skew angle
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Wedge, and the test is set to Face Skew.
1184 PCL Reference Manual
Verify Action
This function will write the element number and the face skew angle value for each element in the current
group that has exceeded the threshold value to the history window.
This function can display a percent complete popup form.
Example:
Description:
This function will load the graphic display tables with the face taper values of all of the wedge elements
in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the face taper
values loaded into the graphic display table are calculated using
a normalization formula.
REAL threshold This value specifies the threshold of failure comparison value.
When the input value normalize is set to TRUE, this value must
be greater than 0.0 and equal to or less than 1.0. When the input
value normalize is set to FALSE, this value must be greater than
0.0 and less than or equal to 2147483600.0
Output:
STRING group_name[31] This value will return a description of the group to which the
test has been applied.
REAL minimum_value This value will return the minimum face taper value.
INTEGER minimum_id This value will return the id of the element with the minimum
face taper value.
REAL maximum_value This value will return the maximum face taper value.
INTEGER maximum_id This value will return the id of the element with the maximum
face taper value.
INTEGER table_id This value returns the id for the table of element face taper
values.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Wedge, and the test is set to Face Taper.
1186 PCL Reference Manual
Verify Action
This function will write the element number and the face taper value for each element in the current group
that has exceeded the threshold value to the history window.
This function can display a percent complete popup form.
Example:
Description:
This function will load the graphic display tables with the face warp values of all of the wedge elements
in the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the face
taper values loaded into the graphic display table are
calculated using a normalization formula.
REAL threshold This value specifies the threshold of failure comparison
value. When the input value normalize is set to TRUE,
this value must be greater than 0.0 and equal to or less
than 1.0. When the input value normalize is set to
FALSE, this value must be greater than 0.0 and less than
or equal to 90.0
Output:
STRING group_name[31] This value will return a description of the group to which
the test has been applied.
REAL minimum_value This value will return the minimum face warp value.
INTEGER minimum_id This value will return the id of the element with the
minimum face warp value.
REAL maximum_value This value will return the maximum face warp value.
INTEGER maximum_id This value will return the id of the element with the
maximum face warp value.
INTEGER table_id This value returns the id for the table of element face
warp values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Wedge, and the test is set to Face Warp.
This function will write the element number and the face warp value for each element in the current group
that has exceeded the threshold value to the history window.
This function can display a percent complete popup form.
Example:
Description:
This function will load the graphic display tables with the twist values of all of the wedge elements in
the current group.
Input:
LOGICAL normalize This value specifies, when set to TRUE, that the twist
values loaded into the graphic display table are calculated
using a normalization formula.
REAL threshold This value specifies the threshold of failure comparison
value. When the input value normalize is set to TRUE, this
value must be greater than 0.0 and equal to or less than 1.0.
When the input value normalize is set to FALSE, this value
must be greater than 0.0 and less than or equal to 120.0
Output:
STRING group_name[31] This value will return a description of the group to which
the test has been applied.
REAL minimum_value This value will return the minimum twist value.
INTEGER minimum_id This value will return the id of the element with the
minimum twist value.
REAL maximum_value This value will return the maximum twist value.
INTEGER maximum_id This value will return the id of the element with the
maximum twist value.
INTEGER table_id This value returns the id for the table of element twist
values.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Wedge, and the test is set to Twist.
1190 PCL Reference Manual
Verify Action
This function will write the element number and the twist value for each element in the current group that
has exceeded the threshold value to the history window.
This function can display a percent complete popup form.
Example:
verify_boundaries_display_mgr.erase ()
Description:
This function will erase the free boundary display in the viewport.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Element, and the test is set to Boundaries.
Example:
verify_boundaries_display_mgr.plot (display_type)
Description:
This function will plot either the free faces or face edges of all of the elements in the model.
Input:
STRING display_type[10] This value specifies the property of the free elements to plot
and can be set to either Free_Edges or Free_Faces.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Verify, the object is set to Element, and the test is set to Boundaries.
See the function verify_boundaries_display_mgr.erase() for more information.
Example:
Show Action
This section is used to describe some of the functions used to show elements and nodes in a finite element
model.
Description:
Display element coordinate systems of selected element.
Input:
INTEGER segment_id Graphic segment ID
STRING c_elem_lp_st[] List processor string with list of elements
INTEGER a_axis_show(3) For each element direction (X/Y/Z) :
0 (FALSE) : Do not plot this axis.
1 (TRUE) : Plot this axis.
INTEGER a_axis_label_show(3) For each element direction (X/Y/Z) :
0 (FALSE) : Do not show axis label.
1 (TRUE) : Show axis label.
INTEGER a_axis_color(3): For each element direction (X/Y/Z) :
Color id (0-15)
INTEGER cs_def_type Element coordinate system definition :
1 : Patran
2 : MSC Nastran
3 : MSC.Marc
INTEGER cs_origin_display_loc element coordinate system origin display location :
1 : Patran definition of element centroid
2 : Selected analysis code element coordinate system
definition (cs_def_type) location.
INTEGER use_offset_1d_elem 0 : (FALSE) Do not consider 1d element (beam) offset for
CS display
1 : (TRUE) Consider 1d element (beam) offset for CS display
Output:
INTEGER <Return Value> Element coordinate system ploted on the selected elements.
Chapter 4: Finite Element Functions 1193
Show Action
Example:
Description:
This function displays freebody data.
Input:
STRING ufb_method[] Choices are: Freebody Loads, Interface Loads, Forced
Displacements.
STRING uresult_title[] Name of the selected Result Case.
STRING usubcase_title[] Title of the selected Result Case.
INTEGER usubcase_id ID of the selected Result Case.
STRING uresult_type[] Choices are: Freebody Loads, Applied Laods, Constraint Forces,
Internal Forces, Summation of Forces, Displacements.
STRING dummy1[] Set to "Summation Point".
STRING usummation_pt[] Summation point coordinates input as "[x y z]" values: Example:
"[0 0 0]".
STRING dummy2[] Set to "Transform Results".
LOGICAL utransform_on TRUE to transform results to different coordinate system,
FALSE otherwise.
STRING ucoord_sys[] Cooridnate system to transform results.
STRING dummy3[] Set to "Entity List".
STRING uelement_list[] List of entities in list processor format. Example "Node,1:10
Elm,1:10".
STRING uvector[] Choices are: Force, Moment, Force/Moment.
1194 PCL Reference Manual
Show Action
Example:
None
1196 PCL Reference Manual
Modify Action
Modify Action
This section is used to describe some of the functions used to modify elements and nodes in a finite
element model.
del_2n_edge_for_all_elm (node_prefer_to_del_id,
node_prefer_to_keep_id, consider_geometry,
reason_why_not)
Description:
This function deletes an element edge for all Tet/Tri/Bar elements using it.
Input:
INTEGER node_prefer_to_del_id
This value specifies the Patran node id for deletion.
This should be the one you prefer to delete.
INTEGER node_prefer_to_keep_i
This value specifies the Patran node id for deletion.
d
This should be the one you prefer to keep.
INTEGER consider_geometry This value specifies the options : 1 (TRUE) if you wish
to consider geometry, otherwise, 0 (FALSE).
STRING reason_why_not This value specifies the virtual string containing : "" for
[VIRTUAL] this string if the edge was deleted. Otherwise (string
length greater than 0), this string holds the reason why
it cannot be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 if no error occurred.
Chapter 4: Finite Element Functions 1197
Modify Action
Description:
This function modifies a fastener connector property record in the database.
Input:
STRING[] name The name of the connector property.
REAL diameter The connector diameter.
REAL(3) kti Stiffness values in directions 1 to 3.
REAL (3) kri Rotation stiffness values in directions 1 to 3.
REAL mass The lumped mass of the fastener.
INTEGER mcid The element stiffness coordinate system (-1 = use element
coordinate system).
INTEGER mflag Defines whether the coordinate system specified for mcid
is absolute (1) or relative (0).
Output:
INTEGER id The ID of the new connector property.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
DbDuplicateEntry
DbMaterialNotFound
Description:
This function retrieves data for a connector property record in the database.
Input:
STRING[] name The name of the connector property.
Output:
STRING[] type The type of connector property (General, Spot Weld,
fastener).
STRING[] mat Name of the reference material property.
REAL(10) rvals Real property values (diameter, Idmin, Idmax, etc.).
INTEGER(10) ivals Integer property values.
INTEGER id The ID of the connector property.
1198 PCL Reference Manual
Modify Action
Description:
This function modifies a connector property record in the database.
Input:
STRING[] name The name of the connector property.
STRING[] type The type of connector property (Generl, Spot Weld).
STRING[] mat Name of the reference material property.
REAL() rvals Real property values (diameter, Idmin, Idmax, etc.).
INTEGER() ivals Integer property values.
Output:
INTEGER id The ID of the connector property.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
DbRegionNotFound
DbPropValNotFound
DbMaterialNotFound
fem_conn_spotweld_modify (id, pname, method, fmt, gs, ga, gb, pata, patb,
sptyp)
Description:
This function modifies spot weld connectors (usually one at a time).
Input:
INTEGER id The starting id for the new connector(s).
STRING[] pname[] The connector property name.
STRING[] method The connector creation method (Projection or Axis).
STRING[] fmt The weld format (ELPAT, PARTPAT, ALIGN,
ELEMID, or GRIDID).
STRING[] gs List of connector locations (nodeds or xyz).
STRING[] ga List of surface A pierce nodes.
STRING[] gb List of surface B pierce nodes.
STRING[] pata List of surface A patch identifiers.
STRING[] patb List of surface B patch identifiers.
1200 PCL Reference Manual
Modify Action
Description:
This function modifies a spot weld connector property record in the database.
Input:
STRING[] name The name of the connector property.
STRING[] mat Name of the reference material property.
REAL diameter The connector diameter.
INTEGER imset The M-Set flag (0=OFF, 1=ON).
Output:
INTEGER id The ID of the new connector property.
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
DbDuplicateEntry
DbMaterialNotFound
Description:
This function will reverse the connectivity of the specified elements, reversing the direction of
the normal vector for those elements.
Input:
STRING element_select[] This value specifies a selection of element identifiers to
be used for the elements being reversed.
Output:
STRING elements_reversed[VIRTUAL]
This value returns a description of the elements which
were reversed.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
1202 PCL Reference Manual
Modify Action
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, the object is set to Element, and the method is set to Reverse.
Space is internally allocated for the string returned by the output value elements_reversed. It is the
responsibility of the calling function to free the allocated string storage space.
Example:
Description:
This function will separate elements at the specified nodes, edges or faces.
Input:
STRING element_select[] This value specifies a selection of element identifiers to be
used for the elements being separated. Element edges and
faces can also be specified with this value.
STRING node_select[] This value specifies a selection of nodes identifying where
the elements will be separated.
INTEGER seperation_option This value specifies the method used to separate elements
from nodes. See the remarks below for more information.
LOGICAL keep_association This value specifies, when set to TRUE, that new nodes that
are created will maintain an association to the model
geometry.
Output:
INTEGER num_nodes This value returns the number of nodes created.
STRING nodes_created[VIRTUAL]
This value returns a description of the nodes created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, the object is set to Element, and the method is set to Separate.
Chapter 4: Finite Element Functions 1203
Modify Action
Space is internally allocated for the string returned by the output value nodes_created. It is the
responsibility of the calling function to free the allocated string storage space.
The integer input value seperation_option can have the following values:
Value Description
Example:
Description:
This function will split quadrilateral elements in a specified pattern using a selection of elements as
input.
Input:
STRING pattern[] This value specifies the pattern into which the quadrilateral
elements will be split and should always be set to nm_quad.
STRING auto_manual[] This value specifies, when set to Manual, that the number of
entities in the input value element_select be counted to
determine how many orientation edges will be needed. This
value can accept two values Auto or Manual and should be
set to Auto if the input values num_selected and
num_orientation equal each other.
STRING element_select[] This value specifies a selection of quadrilateral elements to be
split.
STRING orientation_element[] This value specifies a selection of elements that are used to
specify the orientation of the elements to be split.
INTEGER num_selected This value specifies the number of elements described in the
input value element_select.
INTEGER num_orientation This value specifies the number of element edges described in
the input value orientation_element.
Output:
INTEGER num_nodes_created This value returns the number of nodes created.
INTEGER num_elems_created This value returns the number of elements created.
INTEGER num_nodes_deleted This value returns the number of nodes deleted.
INTEGER num_elems_deleted This value returns the number of elements deleted.
STRING nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING elements_created[VIRTUAL]
This value returns a description of the created elements.
STRING nodes_deleted[VIRTUAL]
This value returns a description of the deleted nodes.
STRING elements_deleted[VIRTUAL]
Chapter 4: Finite Element Functions 1205
Modify Action
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, the object is set to Quad, and the method is set to Split.
Space is internally allocated for the string returned by the output values nodes_created, elements_created,
nodes_deleted, and elements_deleted. It is the responsibility of the calling function to free the allocated
string storage space.
Example:
Description:
This function will modify specified node attributes.
Input:
STRING node_select[] This value specifies a selection of nodes to be modified.
STRING new_node_id[] This value specifies a selection of node identifiers to be
assigned to the modified nodes.
STRING ref_coord_frame[] This value specifies an identifier for the reference
coordinate frame assigned to the modified nodes.
STRING anly_coord_frame[] This value specifies an identifier for the analysis
coordinate frame assigned to the modified nodes.
STRING point_select This value specifies a selection of points to which the
modified nodes will be moved.
INTEGER modify_options(10) This value specifies the manner in which the node
attributes will be modifies. Each offset in the array of
values can be set to 1 to cause the attribute to be modified
or to 0 so that the attribute is not modified. See the remarks
below for more information.
Output:
STRING nodes_modified[VIRTUAL]
This value returns a description of the modified nodes.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, the object is set to Node, and the method is set to Edit, or Move.
Space is internally allocated for the string returned by the output value nodes_modified. It is the
responsibility of the calling function to free the allocated string storage space.
The input value modify_options uses the offsets of the array in the following manner:
Chapter 4: Finite Element Functions 1207
Modify Action
Offset Description
Example:
Description:
This function will move nodes by a specified vector distance.
Input:
LOGICAL transformation_type This value specifies, when set to TRUE, that the move will be
curvilinear in the reference coordinate system. If this value is
set to FALSE, a cartesian move in the reference coordinate
frame will take place.
STRING ref_coord_frame[] This value specifies an identifier for the reference coordinate
frame in which the move will take place.
STRING vector_direction[] This value specifies a vector that defines the direction in which
the nodes will be moved. This vector does not affect the
distance that the move will take, only the direction.
STRING magnitude[] This value specifies how far the nodes will be moved. This
argument is ignored if transformation_type is set to TRUE.
LOGICAL reverse_direction This value specifies, when set to TRUE, that the direction of
the input value vector_direction be reversed.
STRING node_select[] This value specifies a selection of nodes to be modified.
Output:
STRING nodes_modified[VIRTUAL]
This value will return a description of the nodes that have been
modified.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, the object is set to Node, and the method is set to Offset.
Space is internally allocated for the string returned by the output value nodes_modified. It is the
responsibility of the calling function to free the allocated string storage space.
Example:
Description:
This function will modify the specified element attributes.
Input:
STRING new_element_id[] This value specifies a selection of new element identifiers
to be assigned to the modifies elements.
STRING new_shape[] This value specifies a new element shape to assign to the
modified elements. See the remarks below for more
information. This value is currently not used.
STRING new_element_type[] This value specifies a new element topology to assign to the
modified elements. See the remarks below for more
information.
STRING current_node_select[] This value is a selection of nodes describing the current
element nodes to be modified.
STRING new_node_select[] This value is a selection of nodes describing the new
element nodes to which the modified elements will be
assigned.
STRING element_select[] This value specifies a selection of elements to be modified.
INTEGER modify_options(10) This value specifies the manner in which the node attributes
will be modifies. Each offset in the array of values can be
set to 1 to cause the attribute to be modified or to 0 so that
the attribute is not modified. See the remarks below for
more information.
Output:
STRING elements_modified[VIRTUAL]
This value returns a description of the modified elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
1210 PCL Reference Manual
Modify Action
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, the object is set to Element, and the method is set to Edit.
Space is internally allocated for the string returned by the output value elements_modified. It is the
responsibility of the calling function to free the allocated string storage space.
The input value new_shape can be assigned the following values:
The input value modify_options uses the offsets of the array in the following manner:
Chapter 4: Finite Element Functions 1211
Modify Action
Offset Description
Example:
Description:
This function will modify a multi-point constraint which is associated to the specified nodes.
Input:
INTEGER mpc_id This value specifies the id for the multi-point constraint to
be modified.
REAL constant This value specifies the constant term for the multi-point
constraint.
INTEGER num_terms This value specifies the number of terms defined for the
multi-point constraint.
LOGICAL dependency_flag(num_terms)
This value specifies the dependency state for each term of
the multi-point constraint. The term will be dependent if
the value in dependency_flag is set to TRUE and will be
independent if the array value is set to FALSE.
REAL coefficient(num_terms)
This value specifies the coefficient used with each term.
STRING node_select[](num_terms)
This value specifies a selection of nodes associated with
each term.
STRING degrees_of_freedom[](num_terms)
This value specifies the degrees of freedom for each term.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, and the object is set to MPC.
Example:
Description:
This function will modify a multi-point constraint which is associated to the specified nodes.
Input:
INTEGER mpc_id This value specifies the id for the multi-point constraint to be
modified.
REAL constant This value specifies the constant term for the multi-point
constraint.
INTEGER num_terms This value specifies the number of terms defined for the multi-
point constraint.
LOGICAL dependency_flag(num_terms)
This value specifies the dependency state for each term of the
multi-point constraint. The term will be dependent if the value
in dependency_flag is set to TRUE and will be independent if
the array value is set to FALSE.
STRING coefficient(num_terms)
This value specifies the coefficient used with each term.
STRING node_select[](num_terms)
This value specifies a selection of nodes associated with each
term.
STRING degrees_of_freedom[](num_terms)
This value specifies the degrees of freedom for each term.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, and the object is set to MPC.
Example:
None
1214 PCL Reference Manual
Modify Action
Description:
This function will split a set of bars in two.
Input:
STRING element_select[] This value specifies a selection of bars to be split.
Output:
INTEGER num_nodes_created This value returns the number of nodes created.
INTEGER num_elems_created This value returns the number of elements created.
INTEGER num_nodes_deleted This value returns the number of nodes deleted.
INTEGER num_elems_deleted This value returns the number of elements deleted.
STRING nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING elements_created[VIRTUAL]
This value returns a description of the created elements.
STRING nodes_deleted[VIRTUAL]
This value returns a description of the deleted nodes.
STRING elements_deleted[VIRTUAL]
This value returns a description of the deleted elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, the object is set to Bar, and the method is set to Split.
Space is internally allocated for the string returned by the output values nodes_created, elements_created,
nodes_deleted, and elements_deleted. It is the responsibility of the calling function to free the allocated
string storage space.
Example:
Chapter 4: Finite Element Functions 1215
Modify Action
Description
:
This function will split triangular elements in a specified pattern using a selection of elements and
nodes as input.
Input:
STRING pattern[] This value specifies the pattern into which the triangular
elements will be split. See the remarks below for more
information.
STRING auto_manual[] This value specifies, when set to Manual, that the number of
entities in the input value element_select be counted to
determine how many orientation edges will be needed. This
value can accept two values Auto or Manual and the
Manual setting is active only when the input value pattern is
set to either 2_tria or Mixed.
STRING element_select[] This value specifies a selection of triangular elements to be
split.
STRING orientation_node[] This value specifies a selection of nodes that are used to specify
the orientation of the nodes in the elements to be split.
Output:
INTEGER num_nodes_created This value returns the number of nodes created.
INTEGER num_elems_created This value returns the number of elements created.
INTEGER num_nodes_deleted This value returns the number of nodes deleted.
INTEGER num_elems_deleted This value returns the number of elements deleted.
STRING nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING elements_created[VIRTUAL]
This value returns a description of the created elements.
STRING nodes_deleted[VIRTUAL]
This value returns a description of the deleted nodes.
STRING elements_deleted[VIRTUAL]
This value returns a description of the deleted elements
Chapter 4: Finite Element Functions 1217
Modify Action
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, the object is set to Tria, and the method is set to Split.
Space is internally allocated for the string returned by the output values nodes_created, elements_created,
nodes_deleted, and elements_deleted It is the responsibility of the calling function to free the allocated
string storage space.
The input value pattern can have the following values:
2_tria Mixed
3_tria 3_quad
4_tria
Example:
Description:
This function will split quadrilateral elements in a specified pattern using a selection of elements and
nodes as input.
Input:
STRING pattern[] This value specifies the pattern into which the quadrilateral
elements will be split. See the remarks below for more
information.
STRING auto_manual[] This value specifies, when set to Manual, that the number
of entities in the input values orientation_node and
orientation_element be counted. The number of entities in
the input value orientation_node will be counted when the
input value pattern is set 2_tria or 3_quad. The number
of entities in the input value orientation_element will be
counted when the input value pattern is set to 2_quad pr
3_tria. This value can accept two values, Auto or
Manual.
STRING element_select[] This value specifies a selection of quadrilateral elements to
be split.
STRING orientation_node[] This value specifies a selection of nodes that are used to
specify the orientation of the nodes in the elements to be
split.
STRING orientation_element[] This value specifies a selection of element edges that are
used to specify the orientation of the elements to be split.
Output:
INTEGER num_nodes_created This value returns the number of nodes created.
INTEGER num_elems_created This value returns the number of elements created.
INTEGER num_nodes_deleted This value returns the number of nodes deleted.
INTEGER num_elems_deleted This value returns the number of elements deleted.
STRING nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING elements_created[VIRTUAL]
This value returns a description of the created elements.
Chapter 4: Finite Element Functions 1219
Modify Action
STRING nodes_deleted[VIRTUAL]
This value returns a description of the deleted nodes.
STRING elements_deleted[VIRTUAL]
This value returns a description of the deleted elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Modify, the object is set to Quad, and the test is set to Split.
Space is internally allocated for the string returned by the output values nodes_created, elements_created,
nodes_deleted, and elements_deleted. It is the responsibility of the calling function to free the allocated
string storage space.
The input value pattern can have the following values:
2_quad 2_tria
3_quad 3_tria
4_quad 4_tria
Example:
Description:
This function allows users to improve a Tet mesh for Jacobian values.
Input:
INTEGER input_data_qtt This value specifies the quantity of input data strings in
ac_input_data.
STRING[]() ac_input_data This value specifies the input data items. The format for
each data item is : IDENTIFIER=VALUE. For more
information on each of these items, see the description
below where the string is found and its value passed to a
distinct variable.
Output:
LOGICAL mesh_is_acceptable This value will be set to TRUE if the mesh is acceptable;
FALSE if otherwise.
INTEGER worst_tet_iter_info This value returns the information on the number of
iterations performed. Possible values :
Remarks:
1 : Linear
2 : Quadratic
3 : Cubic
4 : Quartic
5 : Quintic
Bar : 1 through 19
Tri : 1 through 5
Quad : 1 through 19
Tet : 1 through 3
Wedge : 1 through 5
Hex : 1 through 19
0 : For Point1.
q >= p+1
*p_gauss_point_qtt = elem_order + 1 ;
CR_Tet_NASTRAN_Weight
CR_Tet_NASTRAN_PowerExp
DihedralMax_Tet_Weight
DihedralMax_Tet_PowerExp
JacobianMin_Weight
JacobianMin_PowerExp
CR_Tet_NASTRAN_Weight
CR_Tet_NASTRAN_PowerExp
DihedralMax_Tet_Weight
DihedralMax_Tet_PowerExp
JacobianMin_Weight
JacobianMin_PowerExp
Mesh_WorstElemIterMax "-1". This serves to establish the maximum count of iteration for
modifying the mesh for each worst element found:
-2 : No limit on iterations.
1 : Linearize...
1230 PCL Reference Manual
Modify Action
-1 : No limit on attempts.
0 : (FALSE) otherwise.
Mesh_HistSesInfoLevel "0". This will control the level of information sent to the
history window and session file during the improvement
processl. The levels are :
0 : No information.
0: FALSE otherwise.
Chapter 4: Finite Element Functions 1231
Modify Action
xample:
Description:
This function allows users to modify the mesh seed on a curve from type to another. For example, a
one way bias seeded edge can be converted to tabular. Users can modify seed on only one curve at a
time.
Input:
STRING curve_list[VIRTUAL] This value specifies a list of curves or edges on which mesh
seeds need to be modified.
INTEGER input_option This value specifies the input option. Valid values are: 1 =
uniform mesh seed with num_elem inputs, 3 = one-way-
biased mesh seed with num_elem and ratio inputs, and 5 =
two-way-biased mesh seed with num_elem and ratio inputs.
INTEGER num_elem This value specifies the number of elements for the curve.
REAL ratio This value specifies the ratio between the last element and the
first. (length2/length1)
REAL length1 This value specifies the length of the first element.
REAL length2 This value specifies the length of the last element.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Description:
This function will delete elements from the database and the graphics window.
Input:
STRING curve_list[VIRTUAL] This value specifies a list of curves or edges on which mesh
seeds need modified.
STRING coord_type[VIRTUA This value specifies the coordinate type. Valid values are:
L] ``Arc Length and``Parametric.
INTEGER num_nodes This value specifies the number of nodes in the table.
(including 0.0 and 1.0)
REAL node_locs(VIRTUAL) This value specifies the node location values. (should be in
[0.0, 1.0])
STRING point_list[VIRTUAL] This value specifies the list of point locations.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Example:
Description:
This function will split all element edges which are longer than a specified value using the specified
node vertices.
Input:
STRING node_lp_str This value specifies a list processor string identifying nodes
used as element edge vertices. This string is used to identify
valid element edges to be considered for splitting.
REAL edge_length_max This value specifies, when positive, the desired maximum
edge length. A negative value will be used to specify a
fraction and can have a value between 0.0 and 0.1. The
absolute value of the negative input will be used to take the
fraction of the longest element edge using node vertices
amongst the supplied nodes.
INTEGER consider_geometry This value when set to one will specify the consideration of
geometry. New nodes will be projected and associated with
the appropriate geometry. New elements will be associated
to geometry. When this value is set to zero, geometry will be
ignored.
Output:
REAL edge_length_max This value will return the maximum edge length used to split
element edges.
STRING reason_why_not[VIRTUAL]
This value will return an empty string if the function
completes normally. Otherwise if the function fails this
string will specify the reason the operation could not be
completed.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This function may return a nonzero value if an error occurs.
Remarks:
simultaneously modified when they share edges or faces. This process is iterative, and each step re-
establishes the "next" longest edge to be split, considering the edge splits in the previous steps.
Description:
This function will split an element edge for all Tet/Tri/Bar elements using it.
Input:
INTEGER node_a_id
This value specifies the Patran first edge vertex node id.
INTEGER node_b_id
This value specifies the Patran second edge vertex node
id.
REAL param_pos This value specifies the parametric position for split.
Values range from 0.0 (1st node) to 1.0 (2nd node).
INTEGER consider_geometry This value specifies the options : 1 (TRUE) if you wish
to consider geometry; 0 (FALSE) otherwise.
STRING reason_why_not This value specifies the virtual string containing : "" for
[VIRTUAL] this string if the edge was split. Otherwise (string
length greater than 0), this string holds the reason why
it could not be split.
Output:
INTEGER <Return Value> This function returns a value of 0 if no error occurred.
Chapter 4: Finite Element Functions 1235
Modify Action
Description:
This function will split an element triangular face for all Tet/Tri elements using it.
Input:
INTEGER node_a_id
This value specifies the Patran first triangular face vertex
node id.
INTEGER node_b_id
This value specifies the Patran second triangular face
vertex node id.
INTEGER node_c_id
This value specifies the Patran third triangular face
vertex node id.
REAL a_area_coors This value specifies the area coordinate parametric
position. Values range from 0.0 to 1.0. The sum of the 3
is equal to 1. The coordinates are normally called
L1/L2/L3, where each value is equal to the smaller
triangle area formed by the mid point and the triangle
edge opposite of the corner, divided by the area of the
whole triangle.
INTEGER consider_geometry This value specifies the options : 1 (TRUE) if we wish to
consider geometry; 0 (FALSE) otherwise.
STRING reason_why_not This value specifies the virtual string containing : "" for
[VIRTUAL] this string if the edge was split. Otherwise (string length
greater than 0) this string holds the reason why we could
not split it.
Output:
INTEGER <Return Value> This function returns a value of 0 if no error occurred.
Description:
This function will split an element edge for all Tet/Tri/Bar elements using it.
1236 PCL Reference Manual
Modify Action
Input:
REAL value_real This value specifies the numerical value.
INTEGER significant_digit_qtt This value specifies the quantity of significant digits
(must be equal or greater to 1). 4 is typical.
INTEGER digits_before_decimal_qtt_max
This value specifies the maximum number of digits
before the decimal point. 5 is typical.
INTEGER leading_0_after_decimal_qtt_max
This value specifies the maximum number of "0" after
the decimal point before the 1st significant digit. 3 is
typical
INTEGER accept_non_0_int_simplification
This value specifies the options (0 is typical) :
Delete Action
This section is used to describe some of the function used to delete elements, nodes, and meshes from a
finite element model.
Description:
This function is used to delete connector elements from the database.
Input:
INTEGER n_conn The number of connectors to be deleted
INTEGER conn_ids(n_conn) Array of connector IDs to be deleted
Output:
STRING conn_deleted_ids(VIRTUAL)
The list of deleted IDs
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None
Example:
None
1238 PCL Reference Manual
Delete Action
Description:
This function will delete elements and their associated nodes from the database and the graphics
window.
Input:
STRING element_select[] This value specifies a selection of nodes and
elements to be deleted.
Output:
STRING deleted_elements[VIRTUAL]
This value returns a description of the deleted
nodes and elements.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Delete and the object is set to Any or Element.
This function will delete an element and any associated nodes for each element listed in the input value
element_select, provided that the element is not essential for any other entity. The element will be deleted
if it meets that criteria and its associated nodes will be deleted provided that they too are not essential to
any other entity. The association of the element with loads, boundary conditions, material properties,
element properties and groups will be broken but these entities will not be deleted. Each element deleted
will be removed from the graphics window.
Space is internally allocated for the string returned by the output value deleted_elements. It is the
responsibility of the calling function to free the allocated string storage space.
Example:
Description:
This function will delete elements from the database and the graphics window.
Input:
STRING element_select[] This value specifies a selection of elements to be deleted.
Output:
STRING deleted_elements[VIRTUAL]
This value returns a description of the deleted elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Delete and the object is set to Any or Element.
This function will delete each element listed in the input value element_select, provided that the element
is not essential for any other entity. Any nodes formerly associated with the deleted elements will not be
deleted. The association of the element with loads, boundary conditions, material properties, element
properties and groups will be broken but these entities will not be deleted. Each element deleted will be
removed from the graphics window.
Space is internally allocated for the string returned by the output value deleted_elements. It is the
responsibility of the calling function to free the allocated string storage space.
Example:
Description:
Deletes a set of nodes from the database and the graphics window.
Input:
STRING node_select[] This value specifies a selection of nodes to be deleted.
Output:
STRING deleted_nodes[VIRTUAL]
This value returns a description of the deleted nodes.
STRING not_found_nodes[VIRTUAL]
This value returns a description of any nodes that were
listed in the input value node_select but not found in
the database.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Delete and the object is set to Node.
This function will delete each node listed in the input value node_select, provided that the node is free
and not essential for any other entity. The association of the node with loads, boundary conditions,
material properties and groups will be broken but these entities will not be deleted. Each deleted node is
removed from the graphics window.
Space is internally allocated for the string returned by the output values deleted_nodes and
not_found_nodes. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Description:
This function will delete a mesh from a set of curves. The curves may be edges of surfaces or solids.
Input:
STRING curve_select[] This value specifies a selection of curves from which the
mesh is to be deleted.
Output:
STRING deleted_mesh[VIRTUAL]
This value returns a description of the curves from which
the mesh was deleted.
STRING not_found_mesh[VIRTUAL]
This value returns a description of the curves from which
there was no mesh that could be deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Delete, the object is set to Mesh and the type is set to Curve.
This function will delete the elements and nodes that comprise the mesh for each curve listed in the input
value curve_select, provided that the elements and nodes are not essential for any other entity. The
association of the elements and nodes with loads, boundary conditions, material properties and groups
will be broken but these entities will not be deleted. Each deleted element and node is removed from the
graphics window.
Space is internally allocated for the string returned by the output values deleted_mesh and
not_found_mesh. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Description:
This function will delete a mesh from a set of surfaces.
Input:
STRING surface_select[] This value specifies a selection of surfaces from which
the mesh is to be deleted.
Output:
STRING deleted_mesh[VIRTUAL]
This value returns a description of the surfaces from
which the mesh was deleted.
STRING not_found_mesh[VIRTUAL]
This value returns a description of the surfaces from
which there was no mesh that could be deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Delete, the object is set to Mesh and the type is set to Surface.
This function will delete the elements and nodes that comprise the mesh for each surface listed in the
input value surface_select, provided that the elements and nodes are not essential for any other entity.
The association of the elements and nodes with loads, boundary conditions, material properties and
groups will be broken but these entities will not be deleted. Each deleted element and node is removed
from the graphics window.
Space is internally allocated for the string returned by the output values deleted_mesh and
not_found_mesh. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Description:
This function will delete a mesh from a set of solids.
Input:
STRING solid_select[] This value specifies a selection of solids from which the
mesh is to be deleted.
Output:
STRING deleted_mesh[VIRTUAL]
This value returns a description of the solids from which
the mesh was deleted.
STRING not_found_mesh[VIRTUAL]
This value returns a description of the solids from which
there was no mesh that could be deleted.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function is used in the implementation of the Finite Elements switch bar form that is displayed
when the action is set to Delete, the object is set to Mesh and the type is set to Solid.
This function will delete the elements and nodes that comprise the mesh for each solid listed in the input
value solid_select, provided that the elements and nodes are not essential for any other entity. The
association of the elements and nodes with loads, boundary conditions, material properties and groups
will be broken but these entities will not be deleted. Each deleted element and node is removed from the
graphics window.
Space is internally allocated for the string returned by the output values deleted_mesh and
not_found_mesh. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Utilities
This section is used to describe a variety of finite element model utility functions.
Description:
This function retrieves fastener connector attributes from the database.
Input:
INTEGER ID The connector ID.
Output:
STRING[] pname The name of the associated connector property.
INTEGER fmt The format of the spot weld (enum: SW_UNKNOWN=0,
SW_PARTPAT=1, SW_ELPAT=2, SW_ELEMID=3,
SW_GRIDID=4, OR SW_ALIGN=5).
INTEGER nid_gs ID of the node at the connector location (if zero, use
xyz_gs - supported for ELPAT and PARTPAT formats
only).
REAL(3) xyz_gs XYZ location of the connector location (used only if
nid_gs is zero - ELPAT and PARTPAT formats only).
INTEGER nid_ga ID of the node at the pierce location on surface patch A
(zero if not specified).
INTEGER nid_gb Id of the node at the pierce location on surface patch B
(zero if not specified).
INTEGER(33) id_pata The element ID, property ID or array of node ids defining
surface patch A (all formats except ALIGN).
INTEGER(33) id_patb The element ID, property ID or array of node ids defining
surface patch B(all formats except ALIGN).
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
DbConnectorNotFound
DbConnectorWrongType
Chapter 4: Finite Element Functions 1245
Utilities
Description:
This function retrieves spot weld connector attributes from the database.
Input:
INTEGER ID The connector ID.
Output:
STRING[] pname The name of the associated connector property.
INTEGER fmt The format of the spot weld (enum: SW_UNKNOWN=0,
SW_PARTPAT=1, SW_ELPAT=2, SW_ELEMID=3,
SW_GRIDID=4, OR SW_ALIGN=5).
INTEGER nid_gs ID of the node at the connector location (if zero, use
xyz_gs - supported for ELPAT and PARTPAT formats
only).
REAL(3) xyz_gs XYZ location of the connector location (used only if
nid_gs is zero - ELPAT and PARTPAT formats only).
INTEGER nid_ga ID of the node at the pierce location on surface patch A
(zero if not specified).
INTEGER nid_gb Id of the node at the pierce location on surface patch B
(zero if not specified).
INTEGER(33) id_pata The element ID, property ID or array of node ids defining
surface patch A (all formats except ALIGN).
INTEGER(33) id_patb The element ID, property ID or array of node ids defining
surface patch B(all formats except ALIGN).
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
DbConnectorNotFound
DbConnectorWrongType
Description:
Given a connector ID, this function retrieves the connector type from the database..
Input:
INTEGER list The connector ID.
1246 PCL Reference Manual
Utilities
Output:
STRING[] type The connector type (e.g., Spot Weld, Fastener).
INTEGER <Return Value> This function returns a value of 0 if successful.
Error Conditions:
MSG_FEM_CONN_NOT_FOUND
Description
:
This function will compare two lists of entities, returning the entities from the second list that have the
smallest geometric distances to entities in the first list.
Input:
STRING source_select[] This value specifies a selection of geometric and finite element
entities. Each entity in this list will be compared against all of the
entities in the input value target_select.
STRING target_select[] This value specifies a selection of geometric and finite element
entities. All of the entities in this list will be compared against
each entity listed in the input value source_select.
Output:
INTEGER entity_count This value will return the number of entities in the returned
values match and distance.
STRING match[VIRTUAL] This value will return a description of the matched entities from
the input value target_select.
REAL distance(VIRTUAL) This value will return the centroid to centroid distance of each
entity listed in the output value match to each entity listed in the
input value source_select.
INTEGER length This value returns the length of the output value match.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
Chapter 4: Finite Element Functions 1247
Utilities
This function computes all distances based on the centroid of the entities in the input lists. Assumptions
are made for geometric entities that will cause the distance calculations for degenerate shapes to be
inaccurate.
This function can make use of finite element model sub-entities but only 2D element edges and 3D
element sub-entities will be accepted.
This function will not return accurate results if cubic elements are used as input.
Space is internally allocated for the string returned by the output values match and distance. It is the
responsibility of the calling function to free the allocated string storage space.
Example:
Description:
This function determines the length of finite element model bar elements and 2D geometric element
edges.
Input:
STRING element_select[] This value specifies a selection of finite element
model bar elements and 2D geometric element edges.
Output:
REAL lengths(VIRTUAL) This value returns the length of each entity in the
input value element_select.
INTEGER entity_count This value returns the number of entities in the input
value element_select and the number of offsets in the
output value lengths.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
None.
Remarks:
This function will not return accurate results if cubic elements are used as input.
Space is internally allocated for the string returned by the output value lengths. It is the responsibility of
the calling function to free the allocated string storage space.
Example:
1248 PCL Reference Manual
Utilities
Description:
This function finds the length of the edge of elements.
Input:
INTEGER edge_count This value specifies the number of edges in the
element_id array.
INTEGER element_id(edge_count) This array specifies the element ids.
INTEGER element_face_id(edge_co This array specifies the element face ids. This value can
unt) be 0, or 1 to 6. Values between 1 and 6 are used to
identify the elements face number. When this value is
equal to 0 the input value element_face_edge_id will
designate the unique edge number.
INTEGER element_face_edge_id(edge_count)
This array specifies the element face edge id. If the input
value element_face_id is greater than 0, this value will
designate the faces edge number for the element face
with a value ranging from 1 to 4. If the input value
element_face_id is equal to 0, this value will designate
the unique edge number of the element with a value that
ranging from 1 to 12.
INTEGER segment_count This value specifies the number of segments by which
an element edge length will be divided. If this value is
0, it will be assumed that the edge of the element will be
comprised of a single segment formed by a straight line
between the nodes making up the corners of the edge of
the element.
Output:
REAL edge_length(VIRTUAL) This array returns the lengths of the element edges. The
number of offsets in the array will be set by the input
value edge_count.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an error.
Error Conditions:
-1 This is an internal error status condition. There is no corresponding status message
in the message database.
1250 PCL Reference Manual
Utilities
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the
call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need
to release the memory of the output variable.
Example:
Description:
This function determines the face area of finite element model shell elements and 3D geometric element
edges.
Input:
STRING element_select[] This value specifies a selection of finite element model shell
elements and 3D geometric element edges.
Output:
REAL areas(VIRTUAL) This value returns the face area of each entity in the input value
element_select.
INTEGER entity_count This value returns the number of entities in the input value
element_select and the number of offsets in the output value
areas.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
This function will not return accurate results if cubic elements are used as input.
Space is internally allocated for the string returned by the output value areas. It is the responsibility of
the calling function to free the allocated string storage space.
Example:
Description:
This function determines the volume of finite element model and 3D geometric elements.
Input:
STRING element_select[] This value specifies a selection of finite element model
and 3D geometric elements.
Output:
REAL volumes(VIRTUAL) This value returns the volume of each entity in the input
value element_select.
INTEGER entity_count This value returns the number of entities in the input
value element_select and the number of offsets in the
output value volumes.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Remarks:
This function will not return accurate results if cubic elements are used as input.
Space is internally allocated for the string returned by the output value volumes. It is the responsibility
of the calling function to free the allocated string storage space.
Example:
Please see fem_geom_elem_volume.
1252 PCL Reference Manual
Utilities
Description:
This function will find the location of the centroid of finite element model and geometric elements,
element faces, and element edges. Note that the centroid locations does not correspond to the center
of gravity for the supplied finite element entities, but instead, to their parametric centers which are then
mapped into real space.
Input:
STRING element_select[] This value specifies a selection of finite element model
elements, element faces, and element edges.
Output:
REAL locations(VIRTUAL) This value returns a two dimensional array specifying the
centroidal locations of each entity in the input value
element_select. See the remarks below for more information.
INTEGER entity_count This value returns the number of entities in the input value
element_select and the number of offsets in the first dimension
of the two dimensional output value locations.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
location(1,1) This is the X axis location of the centroid for the first element listed
in the input value element_select.
location(1,2) This is the Y axis location of the centroid for the first element listed
in the input value element_select.
location(1,3) This is the Z axis location of the centroid for the first element listed
in the input value element_select.
.
.
.
location(entity_count,1) This is the X axis location of the centroid for the last element listed
in the input value element_select.
location(entity_count,2) This is the Y axis location of the centroid for the last element listed
in the input value element_select.
location(entity_count,3) This is the Z axis location of the centroid for the last element listed
in the input value element_select.
Space is internally allocated for the string returned by the output value locations. It is the responsibility
of the calling function to free the allocated string storage space.
Example:
Description:
This function returns information about the definition of a mesh and/or a mesh seed on a curve or on an
edge of a surface or solid.
Input:
INTEGER curve_id This value specifies the internal database identifier value for a
curve or an edge of a surface or solid.
Output:
INTEGER mesh_status This value returns information stating whether the curve or
edge has a finite element mesh, a mesh seed, both a mesh and a
mesh seed, or no mesh or mesh seed defined along its length.
See the remarks below for more information.
INTEGER mesh_type This value returns information about how the mesh or mesh
seed on the curve or edge is defined. See the remarks below for
more information.
INTEGER num_elements This value returns the number of finite element model elements
on the curve or edge specified by the input value curve_id and
the number of offsets in the output value node_locations.
REAL mesh_ratio This value returns the mesh ratio for the finite element model
mesh defined on the curve or edged specified by the input value
curve_id.
INTEGER num_hard This value returns the number of points in each node location.
REAL node_locations [VIRTUAL]
This value returns the curve normalized arc length locations of
the nodes along the specified curve or edge. The number of
offsets defined for this array will be returned by the output
value num_elements.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
Value Description
Value Description
Space is internally allocated for the string returned by the output value node_locations. It is the
responsibility of the calling function to free the allocated string storage space.
Example:
Introduction 1258
Loads and Boundary Conditions 1260
Element Properties 1279
Experimental Data Fitting 1292
Beam Library 1305
Materials 1325
Load Cases 1348
Fields 1355
1258 PCL Reference Manual
Introduction
Introduction
The purpose of this chapter is to list functions used to define and manipulate loads and boundary
conditions (Load/BC or lbc), element properties, the beam library, material properties, load cases, and
fields. These six function groupings are often referred to as functional assignments. Functional
assignments are necessary to turn a collection of finite elements into a complete finite element model.
Loads and Boundary The loads and boundary conditions application provides the ability to apply
Conditions a variety of static and dynamic load and boundary conditions to finite
element models. Load/BCs may be associated with geometric entities as well
as FEM entities. When associated with geometric entities, they are
transferred to finite elements created on the geometry. Load and boundary
conditions are intended to be created in multiple single purpose groups
referred to as sets. These sets are grouped into load cases in the Load Cases
switch bar form. Fields can be used in the definition of load and boundary
conditions. Load/BCs sets remain in the database unless specifically deleted
and thus provide an archival record.
Element Properties The element properties application provides the ability to: define sets of
analysis code specific element properties, and apply, or associate these sets
with selected finite elements. Element properties are created in named
groups that are referred to as sets. The general use of fields in defining sets
is supported. Element property sets also reference material properties created
in the materials switch bar selection. Element property sets remain in the
database unless specifically deleted. The ability to display individual
properties, both in tabular form or visually on the model, is also provided.
Beam Library
The beam library in Patran supports definition of dimensioned beam cross
sections. A library of standard cross sections is available. Each section is
defined using one or more dimensions. The beam library tool supports the
ability to immediately calculate section properties and display a graphic
image of a scaled section. Constant beam cross sections are supported.
Materials The materials application provides the ability to define a grouping of specific
material properties assigned to geometric or finite element entities. Each
material is intended to provide only the information necessary to define the
material properties used with a specific analysis code, analysis type, and
possibly a specific element type.
Chapter 5: Property Assignment Functions 1259
Introduction
Load Cases The load cases application provides the ability to group multiple Load/BCs
into single load cases for application to the model. Load cases remain in the
database unless deleted.
Fields The fields functions enables the creation and maintenance of a library of
complex data sets in a simple and straight forward manner. Fields are used to
define load and boundary conditions as a function of one, two, or three
variables. These variables define material properties as functions of
temperature, strain, strain rate, time and frequency. Fields are used in the
material, load and boundary conditions, and element properties applications.
Fields can be either scalar or vector in nature.
1260 PCL Reference Manual
Loads and Boundary Conditions
Description:
This function creates a new Load/BC set in the database.
Input:
STRING lbc_name[31] This value specifies the new Load/BC set name.
STRING lbc_type[66] This value specifies the Load/BC definition type. See the
remarks below for more information.
STRING lbc_category[31] This value specifies the Load/BC category type: Nodal,
Element Uniform, or Element Variable.
STRING target_element[31] This value specifies the target element type: , 1D,
2D, or 3D.
STRING load_case_type[31] This value specifies the load case type and can be set to
either Static or Time Dependent.
STRING ap_list[]() This value specifies the application region list by entity
types and IDs.
STRING geo_filter[31] This value specifies the geometry filter: Geometry or
FEM.
STRING alt_coord_frame[200] This value specifies the alternate coordinate frame in
which Load/BCs are defined in.
REAL lbc_scale_factor This value specifies the Load/BC set scale factor.
STRING static_data[100](20) This value specifies static data values which could be real
numbers or field names.
STRING dynamic_field_name[200](20)
This value specifies the dynamic field names.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
3001003 %A% is an invalid Load Case Type. Must be Static or Time Dependent.
13000085 Cursor not open
Chapter 5: Property Assignment Functions 1261
Loads and Boundary Conditions
Remarks:
The newly created Load/BC set will be displayed on the application region in the graphics window. If the
Load/BC set is applied to geometry then the display will show the geometric entities, unless the Show
on FEM only toggle is selected on theDisplay, Load/BC/Elem. Props... menu bar form. If there are
any associated FEM entities, then the Load/BC set will be evaluated at the FEM entities and displayed
on them.
Load/BC set is added to the current load case.
1262 PCL Reference Manual
Loads and Boundary Conditions
Displacement Force
Pressure Temperature
Inertial Load Initial Displacement
Initial Velocity Distributed Load
Contact
Example:
Description:
Evaluate the string variable str_lbc_scale_factor if it contains an unevaluated expression. Convert the
scale factor to a real value. Call the loadsbcs_create function to create a new Load/BC set in the
database.
Input:
STRING lbc_name[32] This value specifies the new Load/BC set name.
STRING lbc_type[66] This value specifies the Load/BC definition type. See the
remarks below for more information.
STRING lbc_category[32] This value specifies the Load/BC category type: Nodal,
Element Uniform, or Element Variable.
STRING target_element[32] This value specifies the target element type: , 1D,
2D, or 3D.
STRING load_case_type[32] This value specifies the load case type and can be set to
either Static or Time Dependent.
STRING ap_list[]() This value specifies the application region list by entity
types and IDs.
STRING geo_filter[32] This value specifies the geometry filter: Geometry or
FEM.
STRING alt_coord_frame[200] This value specifies the alternate coordinate frame in
which Load/BCs are defined in.
STRING str_lbc_scale_factor [LBC_DATA_LEN]
This value specifies the Load/BC set scale factor
expression as a string.
STRING static_data[100](20) This value specifies static data values which could be real
numbers or field names.
STRING dynamic_field_name[200](20)
This value specifies the dynamic field names.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
3001003 %A% is an invalid Load Case Type. Must be Static or Time Dependent.
1264 PCL Reference Manual
Loads and Boundary Conditions
Remarks:
This is an interface function that evaluates the scale factor string expression argument. The evaluation
creates a real value that is passed on to the loadsbcs_create function. The purpose of this interface is to
support the use of unevaluated expressions.
The newly created Load/BC set will be displayed on the application region in the graphics window. If the
Load/BC set is applied to geometry then the display will show the geometric entities, unless the "Show
on FEM only" toggle is selected on the"Display", Load/BC/Elem. Props..." menu bar form. If there are
Chapter 5: Property Assignment Functions 1265
Loads and Boundary Conditions
any associated FEM entities, then the Load/BC set will be evaluated at the FEM entities and displayed
on them. Load/BC set is added to the current load case.
The input value lbc_type can be set to the following values:
Displacement Force
Pressure Temperature
Inertial Load Initial Displacement
Initial Velocity Distributed Load
Contact
Example:
None.
1266 PCL Reference Manual
Loads and Boundary Conditions
Description:
Evaluate the string variable str_lbc_scale_factor if it contains an unevaluated expression. Convert the
scale factor to a real value. Place the display vector argument, disp_vec, at the end of the static_data array.
Call the loadsbcs_create function to create a new Load/BC set in the database.
Input:
STRING lbc_name[32] This value specifies the new Load/BC set name.
STRING lbc_type[66] This value specifies the Load/BC definition type. See the
remarks below for more information.
STRING lbc_category[32] This value specifies the Load/BC category type: Nodal,
Element Uniform, or Element Variable.
STRING target_element[32] This value specifies the target element type: , 1D, 2D,
or 3D.
STRING load_case_type[32] This value specifies the load case type and can be set to either
Static or Time Dependent.
STRING ap_list[]() This value specifies the application region list by entity types
and IDs.
STRING geo_filter[32] This value specifies the geometry filter: Geometry or
FEM.
STRING alt_coord_frame[200] This value specifies the alternate coordinate frame in which
Load/BCs are defined in.
STRING str_lbc_scale_factor [LBC_DATA_LEN]
This value specifies the Load/BC set scale factor as a string.
STRING static_data[100](20) This value specifies static data values which could be real
numbers or field names.
STRING disp_vec[200] Computed display vector from the mscnastran
lbc_nsth_inpt_dirc_flux class.
STRING dynamic_field_name[200](20)
This value specifies the dynamic field names.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Chapter 5: Property Assignment Functions 1267
Loads and Boundary Conditions
Error Conditions:
3001003 %A% is an invalid Load Case Type. Must be Static or Time Dependent.
13000085 Cursor not open
13000117 The query specified has completed
14000001 LpGetHeapSpace: Allocated heapspace is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable
14000007 LpSublistType: In the list being used, the current finite element sublist is unclassifiable
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist filter
14000014 LpSublistNext: Attempt to proceed past last sublist in current list
14000015 LpSublistNext: End of current list has been reached
14000201 Invalid output string specified for call
26001010 Load/BC Definition %A% does not exist.
26002010 Load/BC Name is blank. Input a Load/BC Name.
26002011 Load/BC Name %A% is too long. Input 31 characters or less.
26002121 %I% is an invalid number of application regions for the specified Load/BC definition.
26002134 The list %A% contains FEM or unknown GEOmetric entities. All the entities in the
application region(s) must be GEOmetric.
26002135 The list %A% contains GEOmetric or unknown FEM entities. All the entities in the
application region(s) must be FEM.
26002136 %A% is an invalid Geometry Filter. Must be Geometry or FEM.
26002200 There was no data input for this Load/BC Set.
26002201 %I% is an invalid number of input data fields for the specified Load/BC definition.
26006001 Database error encountered: %I%. Call PDA Hotline.
Remarks:
This is an interface function that evaluates the scale factor string expression argument. The evaluation
creates a real value and passes it on to the loadsbcs_create function. The disp_vec argument is placed at
the end of the stat_data array and the evaluated and combined data is passed to the loadsbcs_create()
function. This interface function was required to support the lbc_nsth_inpt_dirc_flux class which creates
a display vector. The purpose of this interface is to support the use of unevaluated expressions.
1268 PCL Reference Manual
Loads and Boundary Conditions
The newly created Load/BC set will be displayed on the application region in the graphics window. If the
Load/BC set is applied to geometry then the display will show the geometric entities, unless the "Show
on FEM only" toggle is selected on the"Display", Load/BC/Elem. Props..." menu bar form. If there are
any associated FEM entities, then the Load/BC set will be evaluated at the FEM entities and displayed
on them. Load/BC set is added to the current load case.
The input value lbc_type can be set to the following values:
Displacement Force
Pressure Temperature
Inertial Load Initial Displacement
Initial Velocity Distributed Load
Contact
loadsbcs_delete (lbc_name)
Description:
This function deletes Load/BC sets from the database.
Input:
STRING lbc_name[31]() This value specifies the Load/BC set names to be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
The deleted Load/BC sets are removed from the database. Each of the deleted Load/BC sets are removed
from the graphics window.
The deleted Load/BC sets are removed from any load cases to which they were associated.
This function can display a fatal popup message form with the following messages:
Chapter 5: Property Assignment Functions 1269
Loads and Boundary Conditions
This function can display a warning popup message form with the following messages:
This function can display an information popup message form with the following message:
Example:
Description:
This function modifies an existing Load/BC set in the database.
Input:
STRING load_case_name[31] This value specifies an existing Load/BC set name.
STRING new_name[31] This value specifies the new Load/BC set name.
STRING lbc_type[31] This value specifies the Load/BC definition type. See the
remarks below for more information.
STRING lbc_category[31] This value specifies the Load/BC category type: Nodal,
Element Uniform, or Element Variable.
STRING target_element[31] This value specifies the target element type: , 1D, 2D,
or 3D.
STRING load_case_type[31] This value specifies the load case type and can be set to either
Static or Time Dependent.
STRING ap_list[]() This value specifies the application region list by entity types
and IDs.
STRING geo_filter[31] This value specifies the geometry filter: Geometry or
FEM.
STRING alt_coord_frame[200 This value specifies the alternate coordinate frame in which
] Load/BCs are defined in.
REAL lbc_scale_factor This value specifies the Load/BC set scale factor.
STRING static_data[100](10) This value specifies static data values which could be real
numbers or field names.
STRING dynamic_field_name[200](10)
This value specifies the dynamic field names.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
3001003 %A% is an invalid Load Case Type. Must be Static or Time Dependent.
13000085 Cursor not open
13000103 No LBC was found
13000117 The query specified has completed
Chapter 5: Property Assignment Functions 1271
Loads and Boundary Conditions
Remarks:
The Load/BC set data is modified in the database. The graphical display of the Load/BCs is modified.
The input value lbc_type can be set to the following values:
1272 PCL Reference Manual
Loads and Boundary Conditions
Displacement Force
Pressure Temperature
Inertial Load Initial Displacement
Initial Velocity Distributed Load
Contact
Example:
Description:
Convert the lbc scale factor from a string variable to a real value and call the loadsbcs_modify function
which modifies an existing Load/BC set in the database.
Input:
STRING load_case_name[32] This value specifies an existing Load/BC set name.
STRING new_name[32] This value specifies the new Load/BC set name.
STRING lbc_type[32] This value specifies the Load/BC definition type. See the
remarks below for more information.
STRING lbc_category[32] This value specifies the Load/BC category type: Nodal,
Element Uniform, or Element Variable.
STRING target_element[32] This value specifies the target element type: , 1D, 2D,
or 3D.
STRING load_case_type[32] This value specifies the load case type and can be set to either
Static or Time Dependent.
STRING ap_list[]() This value specifies the application region list by entity types
and IDs.
STRING geo_filter[32] This value specifies the geometry filter: Geometry or
FEM.
STRING alt_coord_frame[200 This value specifies the alternate coordinate frame in which
] Load/BCs are defined in.
STRING str_lbc_scale_factor[LBC_DATA_LEN]
This value specifies the Load/BC set scale factor as a string.
STRING static_data[100](10) This value specifies static data values which could be real
numbers or field names.
STRING dynamic_field_name[200](10)
This value specifies the dynamic field names.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
3001003 %A% is an invalid Load Case Type. Must be Static or Time Dependent.
13000085 Cursor not open
1274 PCL Reference Manual
Loads and Boundary Conditions
Remarks:
This is an interface function that evaluates the scale factor string expression argument. The evaluation
creates a real value that is passed on to the loadsbcs_modify function. The purpose of this interface is to
support the use of unevaluated expressions.
The Load/BC set data is modified in the database. The graphical display of the Load/BCs is modified.
The input value lbc_type can be set to the following values:
Displacement Force
Pressure Temperature
Inertial Load Initial Displacement
Initial Velocity Distributed Load
Contact
Example:
None.
1276 PCL Reference Manual
Loads and Boundary Conditions
Description:
This function displays contours of the selected data variable on the selected group for a Load/BC in the
current load case.
Input:
STRING lbc_type[31] This value specifies the Load/BC definition type. See the
remarks below for more information.
REAL dynamic_value If this is a dynamic Load/BC set, then this is the dynamic
value (e.g. time) at which contours are desired.
STRING data_variable[31]() This value specifies the selected data variable. If the
Load/BC definition type is Displacement then valid
variable names are Translations <T1 T2 T3> or
Rotations <R1 R2 R3>.
STRING vector_component[31]()
This value specifies the vector component: Resultant,
Component 1, Component 2, or Component 3.
STRING lbc_name[31]() This value specifies the Load/BC set names in the current
load case.
STRING group_names[31]() This value specifies the group names.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in
the message database.
Remarks:
Displacement Force
Pressure Temperature
Inertial Load Initial Displacement
Initial Velocity Distributed Load
Contact
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function plots a graphical display of markers for the selected Load/BC sets in the current load
case.
Input:
STRING lbc_name[31]() This value specifies the Load/BC set names in the current
load case.
STRING group_names[31]( This value specifies the group names on which markers are
) to be plotted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in
the message database.
Remarks:
Markers are displayed for the selected Load/BC sets in the current load case.
This function can display a fatal popup message form with the following messages:
Example:
loadsbcs_show (lbc_name)
Description:
This function shows a tabular display of data for a selected Load/BC set on a spreadsheet, if the
session is interactive.
Input:
STRING lbc_name[31] This value specifies the Load/BC set name in the current
load case.
Output:
INTEGER <Return This function returns a value of 0 when executed
Value> successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message
in the message database.
Remarks:
Element Properties
This section explains the functions that pertain to element properties.
Description:
This function creates an element property set.
Input:
STRING prop_name[31] This value specifies the name of the property set to be created.
INTEGER elem_type_id This value specifies the element type ID.
INTEGER geo_opt_id This value specifies the geometric option ID.
INTEGER con_opt_id This value specifies the condensation option ID.
INTEGER for_opt_id This value specifies the formulation option ID.
INTEGER lam_opt_id This value specifies the laminate option ID.
INTEGER dof_opt_id This value specifies the degree of freedom option ID.
INTEGER property_ids() This value specifies the property ID list.
INTEGER property_types() This value specifies the property data type list.
STRING property_data[256]()
This value specifies the property data.
STRING app_region[] This value specifies the application region.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
8107002 Last command aborted
13000004 Duplicate entry exists in table
13000020 Node not found
13000021 Element not found
13000022 Geometric entity not found
13000032 Point not found
13000041 Element not found
13000089 No default value found
13000090 Analysis code input was not found
1280 PCL Reference Manual
Element Properties
29002026 The material specified for property %A% has an invalid Directionality for this
element type. %A%
29002037 The material specified for property %A% must be a laminate. %A%
29002038 Beam Section %A% not found.
29003001 Property Set %A% cannot be deleted.
29003002 The property set already exists.
29006003 The Property Set Name %A% is invalid.
Remarks:
None.
Example:
Description:
Compress the list of property names. Compress means to find duplicates and merge them while
replacing references.
Input:
INTEGER nitems Number properties selected.
STRING[32]() compress_names Array of property names selected (size = nitems)
INTEGER n_sig Number of signicant digits for REAL property
comparision purposes.
LOGICAL combineDfem Flag whether to combine discrete fem fields referenced
by properties. TRUE=combine, FALSE=do not combine.
LOGICAL deleteComp Flag whether to delete duplicates. TRUE=delete,
FALSE=do not delete.
Output:
INTEGER nCompressed Number of actual properties compressed.
STRING[ 32]() n_compressed Names of properties actually compressed
c_names
INTEGER <Return Value> 0=success, other=error
elementprops_delete (prop_name)
Description:
This function deletes a list of element property sets.
Input:
STRING prop_name[31]( This value specifies the names of the element property sets to be
) deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
Chapter 5: Property Assignment Functions 1283
Element Properties
This function can display a fatal popup message form with the following messages:
This function can display a warning popup message form with the following message:
This function can display an information popup message form with the following message:
Example:
Description:
Expand the property name(s). Expand means to create an individual property per element in the
application region.
Input:
INTEGER opt_flags 1 = do not delete original property set(s); use default property
name: PropName.ElemID
Remarks:
1284 PCL Reference Manual
Element Properties
The opt_flags argument is a single integer that is a sum of the desired options. The values are as listed
below:
Use standard PropName.ElemID 1
Add a prefix.PropName.ElemID 2
Add a PropName.ElemID.Suffix 4
Delete Original Properties 16
For example, to add a suffix, and delete the original property, opt_flags = 4+16 = 20
Example:
None.
Chapter 5: Property Assignment Functions 1285
Element Properties
Description:
This function modifies an existing element property set.
Input:
STRING prop_name[31] This value specifies the name of the property set to be modified.
STRING new_name[31] This value specifies the new name of the property set.
INTEGER elem_type_id This value specifies the element type ID.
INTEGER geo_opt_id This value specifies the geometric option ID.
INTEGER con_opt_id This value specifies the condensation option ID.
INTEGER for_opt_id This value specifies the formulation option ID.
INTEGER lam_opt_id This value specifies the laminate option ID.
INTEGER dof_opt_id This value specifies the degree of freedom option ID.
INTEGER property_ids() This value specifies the property ID list.
INTEGER property_types() This value specifies the property data type list.
STRING property_data[256]()
This value specifies the property data.
STRING app_region[] This value specifies the application region.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
8107002 Last command aborted
13000004 Duplicate entry exists in table
13000020 Node not found
13000021 Element not found
13000022 Geometric entity not found
13000032 Point not found
13000041 Element not found
13000089 No default value found
13000090 Analysis code input was not found
13000091 Analysis type input was not found
1286 PCL Reference Manual
Element Properties
Remarks:
None.
Example:
Description:
This function will set the value for one or more property words in pset_names to the value defined in
prop_string.
Input:
STRING pset_names() String array containing existing property set names. Note that if
this is an empty string, ALL property set names will be
processed.
LOGICAL only_if_exists Controls whether a property value will be added if the value does
not currently exist in the property set. Corresponds to the
Always Update Values toggle in the GUI:
1 Real Scalar
2 Vector
3 Integer
4 String
5 Mat Prop Name
6 Real List
7 Element Nodal
8 Node ID
9 CID
10 Not used
11 Dimensions (for beam sections)
12 Properties (for beam sections)
13 Point XYZ List
1290 PCL Reference Manual
Element Properties
Description:
This function displays the element property values.
Input:
STRING prop_name[31] This value specifies the name of the property to be displayed.
STRING display_type[31 This value specifies the form of the display: Table, Marker
] Plot, Vector Plot, or Scalar Plot.
STRING group_names[31]()
This value specifies a list of the group names to display on.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
8107002 Last command aborted
11000050 The group name is invalid.
11000098 A fatal error has occurred in the database. Database is corrupted.
11000105 The specified group was not found in the database.
11000143 The specified vector result table was not found.
13000008 Group not found
Remarks:
None.
Example:
Description:
Function to read raw experimental data points from a data file and load the points into a Patran field
(of type material). The data typically represents stress vs. strain, stress vs. time, etc. (stress vs.
independent variable).
Input:
STRING field_name Name of the field to be created.
STRING area_name Name of the field to be created containing area/volume vs
independent variable. See remarks below.
STRING variable The independent variable name. e=Strain, t=Time,
T=Temperature, f=Frequency, er=Strain Rate
INTEGER skip_lines Number of header lines to skip in the raw data file (number
greater than or equal to zero).
INTEGER switch Switch the independent variable column (default should be 0;
or set to 1 to switch columns).
STRING file_name The file name containing the raw data.
Output:
None
Remarks:
The raw data files must be two or three columns of data. If three columns, the third column is area or
volume reduction data. If no area_name is given and a third column exists, it will be read and given the
same name as field_name, however each will have a _C1 or _C2 appended to it where _C2 is the
area/volume data and _C1 is the stress/strain or stress/time data. No blank lines or more than three
columns are acceptable in the raw data file. The data file can be space, tab, or comma delimited.
Example:
medr_init ()
Description:
Initializes the experimental data fitting tool. The functions should be called before each data fitting
is done.
Input:
None
Output:
None
Example:
medr_exit ()
Description:
This routine deteles the XY Window and associated curves and cleans up the memory and should be
called when done with the Experimental Data Fitting tool.
Input:
None
Output:
None
Example:
medr_disconnect ()
Description:
This routine diconnects from the Expimental Data Fittings dynamically shared library.
Input:
None
Output:
None
Example:
medr_deleteplot ()
Description:
This routine deletes the XY Window and curves in the Experimental Data Fitting XY Window.
Input:
None
Output:
None
Example:
Description:
Function to set the curve fitting model (e.g.,Neohookean), which test data to use in the curve fit, the
name of the fields containing the test data, and the number of terms to use for series expression fits
(e.g., Ogden). This data must be set prior to performing the curve fit.
Input:
INTEGER model_type 0=Neohookean, 1=Mooney(2), 2=Mooney(3), 3=Signorini,
4=2nd Order Invariant, 5=3rd Order Deformation, 6=Yeoh,
7=Ogden, 8=Foam, 9=Arruda-Boyce, 11=Gent, 15=Visco
Shear Relax, 16=Visco Bulk Relax, 17=Visco Energy Relax
INTEGER test_data 0=All, 1=Uniaxial, 2=Biaxial, 3=Planar Shear, 4=Simple
Shear, 5=Volumetric. (Ignored for Viscoelastic.)
STRING(8) field_names An array of 8 field names. Field1=Uniaxial, Field2=Biaxial,
Field3=Planar Shear, Field4=Simple Shear,
Field5=Volumetric, Field6=Viscoelastic, Field7/Field8=Not
used. If area/volume reduction field exist, they are included
by separating them by commas, e.g.,
uniaxial_C1,uniaxial_C2 Only those fields necessary for
the calculation are required.
INTEGER num_terms The number of terms to calculate. This is only used for
Ogden, Foam, and Viscoelastic curve fits. It is ignored for
the others.
Output:
None.
Example:
Description:
Sets the Experimental Data Fitting calculation options as done on the Optional Parameters button. Must
be called before a data fit is performed.
Input:
INTEGER uniaxial_type Uniaxial reduction data is either A/Ao (0) or V/Vo (1). (A/Ao is
the default.)
INTEGER biaxial_type Biaxial reduction data is either t/to (0) or V/Vo (1). (t/to is the
default.)
INTEGER shear_type Planar shear reduction data is either t/to (0) or V/Vo (1). (t/to is
the default.)
INTEGER math_checks Mathimatical checks are ON (1) or OFF (0). Default is OFF.
INTEGER pos_coeff Force calculation to produce positive coefficients (1). Default is
OFF (0).
INTEGER extrapolate Perform extrapolation of the data: OFF (0), ON (1).
REAL left_bound Left bounds for extrapolation (default 0.0).
REAL right_bound Right bounds for extrapolation (default 0.0).
INTEGER error Error type: Relative=0, Absolute=1. Default is Relative.
REAL error_limit Error limit: default=0.001.
INTEGER num_iterations Number of iterations: default=20.
REAL converge_tol Convergence tolerance: default=1.0e-6.
INTEGER use_fictive Use fictive coefficients: OFF (0), ON(1). Default is OFF.
REAL fictive_coeff Fictive coefficient: default=0.0. Used in Foam fit only.
INTEGER idamage Not used.
Output:
None
Example:
Description:
This routine plots the raw Experimental Data Fitting data and its calculated coefficients and all other
deformation modes requested. Must be called after exp_data_fitting.get_coeffs().
Input:
INTEGER append Flag to continue to append new plots to existing XY Window.
Default=1 (append). Do not append=0.
INTEGER(3) num_vals Array of three values corresponding to the number of valid
values in arrays c1, c2, and c2. These values are displayed
in the Coefficients spreadsheet in the GUI.
REAL(10) c1 Calculated Mooney-Rivilin coefficients for model_types 0-6.
Calculated shear moduli for Ogden and Foam. n k theta & N
for Arruda-Boyce. E & I-m for Gent. Linear terms for
Viscoelastic.
REAL(10) c2 Calculated exponents for Ogden. Deviatoric exponents for
Foam. Relaxation times for Viscoelastic.
REAL(10) c3 Volmetric exponents for Foam, long & short term values for
Viscoelastic.
INTEGER def_modes Number to indicate deformation modes to plot. 1=uniaxial,
2=biaxial, 4=planar shear, 8=simple shear, 16=volumetric,
32=viscoelastic. Combination can be plotted by adding the
respective values together.
Output:
None
Example:
medr_postcurves ( def_modes )
Description:
This routine modifies a Experimental Data Fitting plot after a medr_plotfit() is called.
Input:
INTEGER def_modes Number to indicate deformation modes to plot. 1=uniaxial,
2=biaxial, 4=planar shear, 8=simple shear, 16=volumetric,
32=viscoelastic. Combination can be plotted by adding the
respective values together.
Output:
None
Example:
Description:
This routine sets the material information for the desired material constitutive model.
Input:
INTEGER num_magic The maximum number of material magics (settings on the
Material Input Properties form) for Hyperelastic or Viscoelastic
materials. (num_magic=5)
INTEGER num_props The maximum number of property IDs (num_props=20).
Output:
STRING mat_model The material model name.
INTEGER model_type Experimental curve fitting model.
INTEGER cm_id Material constitutive model ID.
INTEGER lid Material linearity ID.
INTEGER(20 prop_ids Array of property IDs.
)
STRING(20) prop_names Array of property names.
INTEGER magic_ids Array of material magic IDs.
(num_magic)
STRING magic_names Array of material magic names.
(num_magic)
Example:
exp_data_fitting.calculate ( )
Description:
Does the actual Experimental Data Fitting calculations to determine the coefficients, bulk modulus
and corresponding error.
Input:
None
Output:
None
Remarks:
You must call medr_setfield() and medr_setoptions() routines before calling this routine.
Example:
In this example, a raw data field is imported with area reduction data in the third column, the fields
associated to test data type, and the Neohookean curve fit applied and the resulting coefficients are
plotted and saved as a material constitutive model for the MSC.Marc Preference. The uniaxial and biaxial
fit are plotted.
$#
$# Import the raw data from file uniaxial.dat
$#
medr_create_field( "ogden_uniaxial", "", "e", 0, 0, uniaxial.dat" )
$#
$# Calculate the coefficients
$#
medr_init( )
medr_setfields( 0,0,["uniaxial_C1,uniaxial_C2","","","","","","",""],0 )
medr_setoptions( 0,0,0,0,0,0,0.,0.,0,1E-006,20,0.001,0,0.,0 )
exp_data_fitting.calculate( )
$#
$# Plot the data fit (uniaxial and biaxial fits only)
$#
INTEGER model_type, num_vals(3), ntrm
REAL c1(10), c2(10), c3(10)
exp_data_fitting.get_coeffs( model_type,num_vals,c1,c2,c3,ntrm )
medr_plotfit( 1,num_vals,c1,c2,c3,63 ) /* 63=plots all modes */
xy_axis_title_set( "X1", "Strain", 12, 7 )
xy_axis_display_title_set( "X1", TRUE )
xy_axis_title_set( "Y1", "Stress", 12, 7 )
xy_axis_display_title_set( "Y1", TRUE )
medr_postcurves( 3 ) /* 3=plots only uniaxail/biaxial modes */
$#
$# Get the material magics corresponding to the curve fit
$#
STRING mat_model[32], prop_names[32](20), magic_names[32](5)
INTEGER model_type, cm_id, lid, prop_ids(20), magic_ids(5)
medr_get_magic( 5, 20, mat_model, model_type, cm_id, lid, prop_ids, @
prop_names, magic_ids, magic_names )
$#
$# Set properties for material obtained from the curve fit
$#
INTEGER nvprops
Chapter 5: Property Assignment Functions 1301
Experimental Data Fitting
STRING props[32](20)
exp_data_fitting.set_props( model_type,num_vals,c1,c2,c3,nvprops,props )
exp_data_fitting.set_extra_props( model_type, nvprops, prop_ids, @
prop_names, props )
$#
$# Determine if material exists
$#
INTEGER mat_exists, mid
exp_data_fitting.material_exists( "mooney", mat_exists, mid )
$#
$# Create a material constitutive model
$#
material.create( "Analysis code ID", 20, "Analysis type ID", 1, @
"mooney", mid, "Date: 14-Jan-02 Time : 14:59:03", @
"Isotropic", 1, "Directionality", 1, "Linearity", @
lid, "Homogeneous", 0, mat_model, cm_id, @
"Model Options & IDs", magic_names, magic_ids, @
"Active Flag", 1,"Create", mat_exists, @
"External Flag", FALSE, "Property IDs", prop_names,@
prop_ids, "Property Values", props )
$#
$# Clean up
$#
medr_deleteplot( )
medr_exit( )
medr_disconnect( )
1302 PCL Reference Manual
Experimental Data Fitting
Description:
This function gets the coefficients of an Experimental Data Fitting calculation. Must be called after
exp_data_fitting.calculate() and before a plot can be done with medr_plotfit().
Input:
None
Output:
INTEGER model_type 0=Neohookean, 1=Mooney(2), 2=Mooney(3), 3=Signorini,
4=2nd Order Invariant, 5=3rd Order Deformation, 6=Yeoh,
7=Ogden, 8=Foam, 9=Arruda-Boyce, 11=Gent, 15=Visco
Shear Relax, 16=Visco Bulk Relax, 17=Visco Energy Relax
INTEGER(3) num_vals Array of three values corresponding to the number of valid
values in arrays c1, c2, and c2. These values are displayed in
the Coefficients spreadsheet in the GUI.
REAL(10) c1 Calculated Mooney-Rivilin coefficients for model_types 0-6.
Calculated shear moduli for Ogden and Foam. n k theta & N for
Arruda-Boyce. E & I-m for Gent. Linear terms for Viscoelastic.
REAL(10) c2 Calculated exponents for Ogden. Deviatoric exponents for
Foam. Relaxation times for Viscoelastic.
REAL(10) c3 Volmetric exponents for Foam, long & short term values for
Viscoelastic.
INTEGER ntrm Number of terms for an Ogden or Foam fit.
Example:
Description:
This routine sets the property values obtained from the curve fit for subsequently saving as a
constitutive material model.
Input:
INTEGER model_type 0=Neohookean, 1=Mooney(2), 2=Mooney(3),
3=Signorini, 4=2nd Order Invariant, 5=3rd Order
Deformation, 6=Yeoh, 7=Ogden, 8=Foam, 9=Arruda-
Boyce, 11=Gent, 15=Visco Shear Relax, 16=Visco Bulk
Relax, 17=Visco Energy Relax
INTEGER(3) num_vals Array of three values corresponding to the number of valid
values in arrays c1, c2, and c2. These values are
displayed in the Coefficients spreadsheet in the GUI.
REAL(10) c1 Calculated Mooney-Rivilin coefficients for model_types
0-6. Calculated shear moduli for Ogden and Foam. n k
theta & N for Arruda-Boyce. E & I-m for Gent. Linear
terms for Viscoelastic.
REAL(10) c2 Calculated exponents for Ogden. Deviatoric exponents for
Foam. Relaxation times for Viscoelastic.
REAL(10) c3 Volmetric exponents for Foam, long & short term values
for Viscoelastic.
INTEGER nvprops Number of valid properties.
STRING(20) props 32 character property names.
Output:
None
Example:
Description:
This routine sets additional property values required for Viscoelastic material models for
subsequently saving as a constitutive material model. It is called for all material data fitting modules
for consistency.
Input:
INTEGER model_type 0=Neohookean, 1=Mooney(2), 2=Mooney(3), 3=Signorini,
4=2nd Order Invariant, 5=3rd Order Deformation, 6=Yeoh,
7=Ogden, 8=Foam, 9=Arruda-Boyce, 11=Gent, 15=Visco
Shear Relax, 16=Visco Bulk Relax, 17=Visco Energy Relax
INTEGER nvprops Number of valid properties.
INTEGER(20) prop_ids Array of property IDs.
STRING(20) prop_names Array of property names.
STRING(20) props 32 character property names.
Output:
None
Example:
Description:
This function checks for the existence of the given material name and returns the material ID if it
exists.
Input:
STRING material_name Name of the material to check for existence.
Output:
INTEGER mat_exisits Material exists if returns zero.
INTEGER mid Returned material ID.
Example:
Beam Library
This section explains the functions that pertain to beam properties.
Description:
Function to read boundary points and stress recovery points of an arbitrary section in a given file, and
load the points into the spreadsheet in the Beam Library form.
Input:
STRING filename The name of a file listing the boundary points of an arbitrary
beam section (in X,Y coordinates, one point per line) followed
by the stress recovery points (in point indexes.)
Output:
INTEGER npoints Total number of points.
INTEGER nloops Total number of boundary loops.
REAL points (VIRTUAL) X,Y coordinates of all loop points.
INTEGER nploop (VIRTUAL) Number of points on each boundary loop.
INTEGER srp (VIRTUAL) Stress recovery point based on the indexes of the points array.
The file format for the boundary loops that Read File accepts is very straightforward. The only tokens
used are two headers: "Boundary Loops" and "Stress Recovery Points." Under "Boundary Loops" the XY
pairs of the boundary points are listed, one pair per line. If more than one loop are entered, a blank line
is used to separate the loops. Each loop with its points will be read into the spreadsheet sequentially.
Stress recovery points are supported, but not required. To input the stress recovery points, "Stress
Recovery Points" header should be added below the XY pairs and the point indexes which are designated
as Point C, D, E, and F are listed on the line underneath the header. Here is an example that has 2 loops
with 5 points each. The first stress recovery point is the first point in the second loop. The other stress
recovery points are all in the first loop.
Boundary Loops
0. 0.
4. 0.
4. 8.
0. 8.
0. 0.
2. 2.
3. 2.
3. 3.
2. 3.
2. 2.
Description:
Creates a new arbitrary shape beam section with the given section name, boundary loops and stress
recovery points.
Input:
STRING section_name[31] Section name.
INTEGER npoints Total number of points.
INTEGER nloops Total number of boundary loops.
REAL points(npoints,2) X,Y coordinates of all loop points.
INTEGER nploop(nloops) Number of points on each boundary loop.
INTEGER srp(4) Stress recovery point based on the indexes of the points array.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
1 Invalid total number of points.
2 The number of loops is outside the valid range of 1 - 8.
3 Invalid number of points is found in a loop. (Fewer than 3 or greater than 150.)
7 Invalid license.
13000025 Duplicate name.
13000210 The system is out of virtual memory.
13000211 Virtual memory has been exhausted.
29002040 Beam Section %A% already exists. Do you wish to overwrite?
29002042 Beam Section Name is blank. Input a Beam Section Name.
Description:
Function to create a display of an arbitrary section in a graphic viewport. It plots the geometry of the
section, and depending on the given option, it calculates and displays the properties of the arbitrary
section.
Input:
Chapter 5: Property Assignment Functions 1307
Beam Library
Description:
Modifies an existing arbitrary shape beam section with the given section name, boundary loops and
stress recovery points.
Input:
STRING old_name[31] The name of an existing section to be modified.
STRING new_name[31] The new section name to be used.
INTEGER npoints Total number of points.
INTEGER nloops Total number of boundary loops.
REAL points(npoints,2) X,Y coordinates of all loop points.
INTEGER nploop(nloops) Number of points on each boundary loop.
INTEGER srp(4) Stress recovery point based on the indexes of the points array.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
1 Invalid total number of points.
2 The number of loops is outside the valid range of 1 - 8.
3 Invalid number of points is found in a loop. (Fewer than 3 or greater than 150.)
7 Invalid license.
13000210 The system is out of virtual memory.
13000211 Virtual memory has been exhausted.
29002042 Beam Section Name is blank. Input a Beam Section Name.
Description:
Write section properties and the information of loops and points for an arbitrary section to the report
file.
Input:
STRING section_name[] Section name.
INTEGER npoints Total number of points.
Chapter 5: Property Assignment Functions 1309
Beam Library
Description:
Function to find the sampling points on the boundary of the given surface and load the points into the
spreadsheet.
Input:
STRING surface_picklist Picklist of a surface on which the boundary points to be
found and loaded to the spreadsheet.
REAL curv_factor Maximum curvature error ( .01 <= h/L <= .25 ) allowed for
sampling points on a curved edge.
LOGICAL transl Whether or not to translate the boundary points so that the
first point of the first loop coincides with the origin.
Output:
INTEGER npoints Total number of points.
INTEGER nloops Total number of boundary loops.
REAL points(VIRTUAL) X,Y coordinates of all loop points.
INTEGER nploop(VIRTUAL Number of points on each boundary loop.
)
Error Conditions:
1 Surface selected is meshed and cannot be processed.
2 Property evaluation fails.
3 The number of points found on a loop exceeds 150.
29001001 Unable to allocate the necessary memory.
29002060 An error occurred while computing Beam Section properties. Check the
boundary.
29002056 An error occurred while computing Beam Section properties. Check dimensions.
Description:
This function creates a new beam section with the given name, shape, and a list of dimensions.
Input:
STRING beam_name[31 This value specifies the name of the beam section to be created.
]
Chapter 5: Property Assignment Functions 1311
Beam Library
STRING beam_shape[8] This value specifies the shape name of the beam section. See the
remarks below for more information.
STRING beam_data[31]( This value specifies the data defining the dimensions of the beam.
)
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
13000025 Duplicate name
13000121 The property value requested was not found
13000210 The system is out of virtual memory.
13000211 Virtual memory has been exhausted.
29002040 Beam Section %A% already exists. Do you wish to overwrite?
29002042 Beam Section Name is blank. Input a Beam Section Name.
29002043 Beam Section Type %A% Invalid.
29002044 Wrong number of Beam Section Dimensions Input.
29002046 Invalid Beam Section Dimension %A%.
29003007 Section %A% associated with Element Property data and is not deleted.
30001101 Field %A% does not exist.
Remarks:
Value Description
I for I beam
L for angle
T for blade
CHAN for channel
TUBE for tube or pipe
ROD for circular solid rod
BOX for rectangular hollow bar with symmetric walls
BAR for rectangular solid bar
BOX1 for rectangular hollow bar with unsymmetric walls
Z for Z shape beam
HAT for hat shape beam
CROSS for cross shape beam
HEXA for hexagonal beam
Example:
beam_section_delete (beam_name)
Description:
This function deletes a list of beam sections.
Input:
STRING beam_name[31]() This value specifies the names of the beams to be
deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000121 The property value requested was not found
13000210 The system is out of virtual memory.
13000213 A database lookup failed to locate the target index key.
29003007 Section %A% associated with Element Property data and is not deleted.
Remarks:
None.
Example:
Description:
This function calculates the beam cross section properties, and displays the beam cross section and its
properties in a graphic viewport.
Input:
STRING beam_shape[] This value specifies the shape name of the beam section. See the
remarks below for more information.
STRING beam_name[] This value specifies the name of the beam section to be written.
STRING beam_data[]() This value specifies a string array of dimensions in order of the
labels shown on the beam library form. Strings of real numbers
and field names prefixed by f: are allowed.
STRING ent_or_loc[] This value specifies, if the input value beam_data contains any
fields, that the field data be evaluated as a geometric entity when
this value is set to ENTITY or that the field data will be
evaluated at XYX coordinates when this value is set to
COORD.
STRING ent_loc_data[] This value specifies the geometric entity or XYZ coordinate
information if the input value beam_data contains any fields.
REAL field_location This value specifies the parametric location at which fields are
evaluated. This value is used only if the input value beam_data
contains any fields and the input value ent_or_loc is set to
ENTITY. This value must be equal to or greater than 0 and
equal to or less than 1.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
This function can return error values which have no association with an error message.
Remarks:
Value Description
I for I beam
L for angle
T for blade
CHAN for channel
TUBE for tube or pipe
ROD for circular solid rod
BOX for rectangular hollow bar with symmetric walls
BAR for rectangular solid bar
BOX1 for rectangular hollow bar with unsymmetric walls
Z for Z shape beam
HAT for hat shape beam
CROSS for cross shape beam
HEXA for hexagonal beam
This function can display a fatal popup message form with the following messages:
Example:
Description:
This function modifies an existing beam section by replacing its name, shape, and dimensions.
Input:
STRING beam_name[31 This value specifies the name of the beam section to be
] modified.
STRING new_name[31] This value specifies the new name of the beam section.
STRING beam_shape[3 This value specifies the shape name of the beam section. See
1] the remarks below for more information.
STRING beam_data[31] This value specifies the data defining the dimensions of the
() beam.
Output:
INTEGER <Return This function returns a value of 0 when executed
Value> successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000025 Duplicate name
13000211 Virtual memory has been exhausted.
13000213 A database lookup failed to locate the target index key.
29002042 Beam Section Name is blank. Input a Beam Section Name.
29002043 Beam Section Type %A% Invalid.
29002044 Wrong number of Beam Section Dimensions Input.
29002046 Invalid Beam Section Dimension %A%.
30001101 Field %A% does not exist.
Remarks:
Value Description
I for I beam
L for angle
T for blade
CHAN for channel
TUBE for tube or pipe
ROD for circular solid rod
BOX for rectangular hollow bar with symmetric walls
BAR for rectangular solid bar
BOX1 for rectangular hollow bar with unsymmetric walls
Z for Z shape beam
HAT for hat shape beam
CROSS for cross shape beam
HEXA for hexagonal beam
Example:
Description:
This function writes the given information of a beam section and the calculated section properties to
the report file.
Input:
STRING beam_shape[] This value specifies the shape name of the beam section. See the
remarks below for more information.
STRING beam_name[] This value specifies the name of the beam section to be written.
STRING beam_data[]() This value specifies the data defining the dimensions of the beam.
STRING ent_or_loc[] This value specifies, if the input value beam_data contains any
fields, that the field data be evaluated as a geometric entity when
this value is set to ENTITY or that the field data will be
evaluated at XYX coordinates when this value is set to COORD.
STRING ent_loc_data[] This value specifies the geometric entity or XYZ coordinate
information if the input value beam_data contains any fields.
REAL field_location This value specifies the parametric location at which fields are
evaluated. This value is used only if the input value beam_data
contains any fields and the input value ent_or_loc is set to
ENTITY. This value must be equal to or greater than 0 and equal
to or less than 1.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
Value Description
I for I beam
L for angle
T for blade
CHAN for channel
TUBE for tube or pipe
ROD for circular solid rod
BOX for rectangular hollow bar with symmetric walls
BAR for rectangular solid bar
BOX1 for rectangular hollow bar with unsymmetric walls
Z for Z shape beam
HAT for hat shape beam
CROSS for cross shape beam
HEXA for hexagonal beam
This function can display a fatal popup message form with the following messages:
Example:
Description:
Function to find the X,Y coordinates of the boundary points, the numbers of points on each loop, and
the stress recovery points with the given database section ID.
Input:
INTEGER id The database ID of an existing arbitrary section.
Output:
REAL points(npoints, X,Y coordinates of all boundary points in sequence.
2)
INTEGER nploop(nloops) Number of points on each boundary loop.
INTEGER srp(4) Stress recovery points using the indexes in the points array.
Return:
INTEGER status The status from database function calls (OK = 0 ).
Description:
Function to find the number of points and the number of loops with the given section ID.
Input:
INTEGER id The database ID of an existing arbitrary section.
Output:
INTEGER npoints The total number of boundary points of the arbitrary section.
INTEGER nloops The number of boundary loops of the arbitrary section.
Return:
INTEGER status The status from database function calls (OK = 0 ).
Description:
This function finds the coordinates of the shear center of an arbitrary section with the given section
properties and centroid coordinates.
Input:
INTEGER entyp Entity type =1 for PBAR, =2 for PBEAM.
Chapter 5: Property Assignment Functions 1321
Beam Library
REAL prop (30) Section properties calculated in the order of the property fields
in the MSC Nastran entries.
REAL centroid (2) X,Y coordinates of the centroid.
Output:
REAL shear (2) X,Y coordinates of the shear center of the arbitrary section.
1322 PCL Reference Manual
Beam Library
Description:
Function to calculate the exterior perimeter of an arbitrary section.
Input:
INTEGER np The number of points on the outer loop (Loop 1.)
REAL points (np,2) X,Y coordinates of all boundary points in sequence.
Output:
REAL perim The exterior perimeter of the arbitrary section.
Description:
Function to compute the sectional properties for a given arbitrary section boundary defined by a
number of loops each containing a series of points. This function requires a license for the beam
evaluator. If a license is not available, it will return a value of 7, and display a message.
Input:
INTEGER entyp Entity type =1 for PBAR, =2 for PBEAM.
INTEGER npoints Number of total boundary points.
INTEGER nloops Number of boundary loops.
REAL points(npoints,2) X,Y coordinates of all boundary points in sequence.
INTEGER nploop(nloops) Number of points on each boundary loop.
INTEGER srp(4) Stress recovery points using the indexes in the points array.
Output:
REAL prop (30) Section properties calculated in the order of the property fields in
the MSC Nastran entries. (See below)
INTEGER nprop The number of valid properties in the prop array.
REAL centroid (2) XY coordinates of the centroid.
Return:
INTEGER status 0- OK
1,2,3 - invalid section
5- invalid entyp
6- zero area
7- No license
Chapter 5: Property Assignment Functions 1323
Beam Library
Description:
Create a centerline section with the given section name and branch information.
Input:
STRING section_name Section name
INTEGER numbranches Number of branches "n".
REAL bbx Beginning x point.
REAL bby Beginning y point.
REAL (n) xloc Ending x points for each branch.
REAL (n) yloc Ending y points for each branch.
REAL (n) Tb Beginning thicknesses for each branch.
REAL (n) Te Ending thicknesses for each branch.
REAL (n) bdx Beginning x slopes for each branch.
REAL (n) bdy Beginning y slopes for each branch.
REAL (n) edx Ending x slopes for each branch.
REAL (n) edy Ending y slopes for each branch.
REAL (n) slen Arc lengths for each branch.
INTEGER (4) srp Stress Recovery points.
INTEGER (n) ndiv # Division
REAL arctol Max Chordal deviation for curved sections.
Output:
None.
Chapter 5: Property Assignment Functions 1325
Materials
Materials
This section explains the functions that pertain to material composites..
Description:
This function will create or modify a material in the database.
Input:
STRING analysis_code[31] This value specifies the analysis code label and should be set
to Analysis code ID.
INTEGER analysis_code_id This value specifies the analysis code ID.
STRING analysis_type[31] This value specifies the analysis type label and should be set
to Analysis type ID.
INTEGER analysis_type_id This value specifies the analysis type ID.
STRING material_name[31] This value specifies the name of the material to be created.
INTEGER material_id This value specifies the material ID. This value should be set
to 0 if this is a newly defined material.
STRING material_descrip[] This value specifies the material description.
STRING material_cat[31] This value specifies the material category: Isotropic, 3d
Orthotropic, 3d Anisotropic, 2d Orthotropic, or 2d
Anisotropic.
INTEGER material_cat_id This value specifies the material category ID: 1=Isotropic;
2=3d Orthotropic; 3=3d Anisotropic; 4=2d Anisotropic; and
5=2d Orthotropic.
STRING directionality[31] This value specifies the directionality name and should be set
to Directionality.
INTEGER directionality_id This value specifies the material directionality ID: 0=N/A;
1=Isotropic; 2=Orthotropic; 3=Anisotropic; 4=2d
Orthotropic; and 5=2d Anisotropic.
STRING linearity[31] This value specifies the linearity name and should be set to
Linearity.
1326 PCL Reference Manual
Materials
INTEGER linearity_id This value specifies the linearity ID: 0=N/A; 1=Linear
Elastic; 2=Nonlinear Elastic; 3=Elastoplastic;
4=Hyperelastic; 5=Viscoelastic; and 6=Creep.
STRING mat_type_name[31] This value specifies the material type name: homogeneous,
laminate, rule of mixtures, Halpin-Tsai, short fiber
composite, or an externally defined material.
INTEGER mat_type_id This value specifies the material type ID: 0=homogeneous;
1=laminate; 2=rule of mixtures; 3=Halpin-Tsai; 4=short fiber
composite; and 101=externally defined material.
STRING const_model_name[31]
This value specifies the constitutive model name: Linear
Elastic, Nonlinear Elastic, Elastoplastic, Failure,
Creep, Viscoelastic, Swelling, Thermal, or
Hyperelastic.
INTEGER const_model_id This value specifies the constitutive model ID: 1=Linear
Elastic; 2=NonLinear Elastic; 3=Elastoplastic; 4=Failure;
5=Creep; 7=Viscoelastic; 8=Swelling; 10=Thermal; and
11=Hyperelastic.
STRING options[] This value specifies the model options label and should be set
to Model Options & IDs.
STRING option_names[31]() This value specifies the material option names. See the
remarks below for more information.
INTEGER option_ids() This value specifies the material options IDs. See the remarks
below for more information.
STRING active[31] This value specifies the active label and should be set to
Active Flag.
INTEGER active_status This value specify the constitutive model status: 0 = if the
model has not been activated, and 1 = if the constitutive
model has been activated.
STRING action[31] This value specifies, when set to Create, that a new material
be created. If this value is set to Modify, the material named
by the input value material_name will be modified.
INTEGER material_exists This value specifies the material exists state and should be set
as follows: 10 = if the input value action is set to Create and
material doesnt exist, 11 = if the input value action is set to
Create and material exists, 30 = if the input value action is
set to Modify and material doesnt exist, and 31 = if the
input value action is set to Modify and material exists.
STRING external[31] This value specifies the external flag label and should be set
to External Flag.
Chapter 5: Property Assignment Functions 1327
Materials
LOGICAL external_status This value specifies, when set to TRUE, that this material is
externally defined. If this value is set to FALSE, this material
is internally defined.
STRING prop_ids_label[31] This value uses the string Property IDs.
STRING prop_names[31]() This value specifies the property names. See the remarks
below for more information.
INTEGER prop_ids() This value specifies the property IDs. See the remarks below
for more information.
STRING prop_values_label[31 This value specifies the property values label and should be
] set to Property Values.
STRING prop_values[31]() This value specifies the property values.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
13000004 Duplicate entry exists in table
13000120 The material specified in the query was not found
13000164 The constitutive model was not found in the database.
13000210 The system is out of virtual memory.
1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
Material options must be uniquely defined for a specific analysis code. But, for the sake of data transfer
the material option IDs used should remain the same. The IDs which should be used for specific material
options are given below. If the material option of interest does not exist in the following list, a new and
unique ID should be used. Users and third parties should define IDs in the range 20000 to 29999 to avoid
conflicts with MSC defined IDs.
1328 PCL Reference Manual
Materials
The list of material property IDs and their names are defined by the PCL function load_generics(). These
values are as follows:
Chapter 5: Property Assignment Functions 1329
Materials
93 Coupling Stiffness 11
94 and 95 Not Used
96 Coupling Stiffness 22
97 Coupling Stiffness 23
98 Coupling Stiffness 33
99 Tension Stress Limit
100 Compression Stress Limit
101 Shear Stress Limit
102 Tension Stress Limit 22
103 Compression Stress Limit 22
104 Shear Stress Limit 23
105 Tension Stress Limit 33
106 Compression Stress Limit 33
107 Shear Stress Limit 31
108 Tension Strain Limit
109 Compression Strain Limit
110 Shear Strain Limit
111 Tension Strain Limit 22
112 Compression Strain Limit 22
113 Shear Strain Limit 23
114 Tension Strain Limit 33
115 Compression Strain Limit 33
116 Shear Strain Limit 31
117 Height Ratio
118 and 119 Not Used
120 Hardening Slope
121 Yield Point
122 Equivalent Yield Stress (J1)
123 Alpha
124 Beta
125 Stress 11 Yield Ratio
126 Stress 22 Yield Ratio
127 Stress 33 Yield Ratio
128 Stress 12 Yield Ratio
129 Stress 23 Yield Ratio
130 Stress 31 Yield Ratio
131 Internal Friction Angle
132 Bonding Shear Stress Limit
133 Interaction Term
134 Failure Index
135 Creep Reference Temperature
136 Creep Threshold Factor
1332 PCL Reference Manual
Materials
Description:
This function will create or modify a laminated composite material in the database given the
stacking sequence.
Input:
STRING material_name[31] This value specifies the name of the laminate to be created.
STRING material_descrip[] This value specifies the material description.
INTEGER stack_sequence This value specifies the stacking sequence convention:
1=Total; 2=Symmetric; 3=Symmetric/Mid-Ply; 4=Anti-
Symmetric; and 5=Anti-Symmetric/Mid-Ply.
STRING ply_names[31](num_names)
This value specifies an array of ply material names for a
laminate with the number of plies specified by the input
value num_names. If the input value stack_sequence is set
to 2 or 4, only the first (num_names)/2 ply material names
need to be specified. If the input value stack_sequence is
set to 3 or 5, then only the (num_names+1)/2 ply material
names need to be specified.
REAL thicks(num_names) This value specifies the ply thicknesses for a laminate with
the number of plies specified by the input value
num_names. If the input value stack_sequence is set to 2
or 4, only the first (num_names)/2 ply material names
need to be specified. If the input value stack_sequence is
set to 3 or 5, then only the (num_names+1)/2 ply material
names need to be specified.
REAL orients(num_names) This value specifies the ply orientations for a laminate
with the number of plies specified by the input value
num_names. If the input value stack_sequence is set to 2
or 4, only the first (num_names)/2 ply material names
need to be specified. If the input value stack_sequence is
set to 3 or 5, then only the (num_names+1)/2 ply material
names need to be specified.
INTEGER num_names This value specifies the number of offsets defined for the
input values ply_names, thicks, and orients.
STRING offset_string[] This value specifies the list processor offset string.
1336 PCL Reference Manual
Materials
STRING action[] This value specifies, when set to Create, that a new
laminate be created. If this value is set to Modify, the
laminate named by the input value material_name will be
modified.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in
the message database.
Remarks:
The laminate definition data and properties are stored in the database.
This function can display a fatal popup message form with the following message:
This function can display a query popup message form with the following message:
This function can display an acknowledge popup message form with the following message:
Example:
Description:
This function will create or modify a laminated composite material in the database given the stacking
sequence.
Input:
STRING material_name[32] This value specifies the name of the laminate
to be created.
STRING material_descrip[] This value specifies the material description.
INTEGER stack_sequence This value specifies the stacking sequence
convention: 1=Total; 2=Symmetric;
3=Symmetric/Mid-Ply; 4=Anti-Symmetric;
and 5=Anti-Symmetric/Mid-Ply.
STRING ply_names[32](num_names)
This value specifies an array of ply material
names for a laminate with the number of
plies specified by the input value
num_names. If the input value
stack_sequence is set to 2 or 4, only the first
(num_names)/2 ply material names need to
be specified. If the input value
stack_sequence is set to 3 or 5, then only the
(num_names+1)/2 ply material names need
to be specified.
STRING thicks(num_names) This value specifies the ply thicknesses for a
laminate with the number of plies specified
by the input value num_names. If the input
value stack_sequence is set to 2 or 4, only the
first (num_names)/2 ply material names
need to be specified. If the input value
stack_sequence is set to 3 or 5, then only the
(num_names+1)/2 ply material names need
to be specified.
1338 PCL Reference Manual
Materials
Error Conditions:
1 This is an internal status condition. There is no corresponding status
message in the message database.
Remarks:
The laminate definition data and properties are stored in the database.
This function can display a fatal popup message form with the following message:
This function can display a query popup message form with the following message:
This function can display an acknowledge popup message form with the following message:
Example:
None.
Chapter 5: Property Assignment Functions 1339
Materials
Description:
This function will create or modify a rule of mixtures material in the database given the definition
data, including constituent material names, volume fractions, and orientation angles.
Input:
STRING material_name[31] This value specifies the name of the rule of mixtures
material to be created.
STRING material_descrip[] This value specifies the material description.
STRING phase_materials[] This value specifies a list processor string defining all of the
materials comprising the different phases of the rule of
mixtures material.
STRING volume_fractions[] This value specifies a list processor string defining the
volume fractions for the different phases of materials. The
number of volume fractions defined must equal the number
of phase materials defined or the number of phase materials
defined - 1. If the last volume fraction is not defined, it will
be calculated internally on the assumptions that the sum of
all of the volume fractions must be one.
STRING orientation_angles[] This value specifies a list processor string defining the
orientation angles of each material phase. The number of
orientation angles defined must be equal to 3 * the number
of material phases defined. Each set of three space fixed
rotation angles define a coordinate frame transformation
from the composite material coordinate frame to the phase
material coordinate frame.
STRING action[] This value specifies, when set to Create, that a new rule
of mixtures material be created. If this value is set to
Modify, the rule of mixtures material named by the input
value material_name will be modified.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
1340 PCL Reference Manual
Materials
Remarks:
The Rule-of-Mixtures material definition data and properties are stored in the database.
This function can display a fatal popup message form with the following message:
This function can display a query popup message form with the following message:
This function can display an acknowledge popup message form with the following message:
This is the recommended built-in function for creating a Rule-of-Mixtures material.
Example:
Description:
This function will create or modify a Halpin-Tsai material in the database given the definition data,
which include the option number, fiber and matrix volume fractions, fiber aspect ratios, and empirical
factors.
Input:
STRING material_name[31] This value specifies the name of the halpin-tsai material to be
created.
STRING material_descrip[] This value specifies the material description.
INTEGER option_number This value specifies the halpin-tsai option number indicating
phase geometry: 1=continuous fiber; 2=discontinuous fiber;
3=continuous ribbon; 4=discontinuous ribbon; and
5=particulate.
REAL fiber_volume_fract This value specifies the fiber or particulate volume fraction.
REAL matrix_volume_fract This value specifies the matrix volume fraction. The input
value fiber_volume_fract + the input value
matrix_volume_fract must not exceed one.
INTEGER theory This value specifies the theory type: 1=new theory (GTT);
and 2=old theory (NUTT). This value is used only when the
input value option_number is set to 1.
STRING aspect_ratios[31]() This value specifies the fiber aspect ratios: if the input value
option_number=2 then use length/diameter; if the input value
option_number=3 then use width/thickness; and if the input
value option_number=4 then use length/thickness and
width/thickness.
LOGICAL override If this value is set to TRUE, then use the empirical factors in
the input value fudge_factors. If this value is set to FALSE
do not use the input value fudge_factors.
STRING fudge_factors[31]() This value specifies the empirical factors tailored to the
material geometry. These depend on the input value
option_number and correspond to the empirical factors given
on the form for each Halpin-Tsai option.
STRING fiber_name[] This value specifies the name of the fiber or particulate
material.
STRING matrix_name[] This value specifies the name of the matrix material.
1342 PCL Reference Manual
Materials
STRING action[] This value specifies, when set to Create, that a new material
be created. If this value is set to Modify, the material named
by the input value material_name will be modified.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
The Halpin-Tsai material definition data and properties are stored in the database.
This function can display a fatal popup message form with the following message:
This function can display a query popup message form with the following message:
This function can display an acknowledge popup message form with the following message:
Example:
Description:
This function will create or modify a short fiber composite material in the database given the
definition data, which consist of a unidirectional two-phase material with statistical parameters.
Input:
STRING material_name[31] This value specifies the name of the short fiber composite to
be created.
STRING material_descrip[] This value specifies the material description.
INTEGER option_number This value specifies the dimensionality of fiber variation: if
the input value option_number=1 then use 1-dimensional
variation; and if the input value option_number=2 then use
2-dimensional variation.
REAL mean_angle_theta This value specifies the first mean orientation angle in
degrees.
REAL mean_angle_phi This value specifies the second mean orientation angle in
degrees. This value is not used if the input value
option_number is set to 1.
REAL stand_dev_theta This value specifies the standard deviation with respect to
in degrees. It must be positive, and, if the input value
option_number=2, then it cannot exceed 30.0.
REAL stand_dev_phi This value specifies the standard deviation with respect to
in degrees. It must be positive and it cannot exceed 30.0.
This value is not used if the input value option_number is set
to 1.
REAL correlation_coef This value specifies the correlation coefficient. This value is
not used if the input value option_number is set to 1.
INTEGER num_iterations This value specifies the number of monte carlo iterations.
STRING uni_mat_name[] This value specifies the unidirectional two-phase material
name.
STRING action[] This value specifies, when set to Create, that a new
material be created. If this value is set to Modify, the
material named by the input value material_name will be
modified.
Output:
1344 PCL Reference Manual
Materials
Remarks:
The Short Fiber composite material definition data and properties are stored in the database.
This function can display a fatal popup message form with the following message:
This function can display a query popup message form with the following message:
This function can display an acknowledge popup message form with the following message:
Example:
Description:
This function will set/modify the value for one or more values for one or more materials.
Input:
STRING[]() mat_names String array containing existing material names whose values
are to be modified. If mat_names is input as a single element
array with an empty string (ie. "[""]"), ALL materials will be
processed.
LOGICAL only_if_exists Logical flag that controls whether a material value will be
created if the value does not currently exist in the material. If
TRUE, the value will only be set if the value exists.
INTEGER cat_id Material category id:
Isotropic = 1
Orthotropic = 2
Anisotropic = 3
2D Anisotropic = 4
2D Orthotropic = 5
Composite = 6
It is best to use the form to find the id for your specific case, as
these are code dependent.
INTEGER con_mod_id Material constitutive model ID.
Elastic = 1
Nonlinear Elastic = 2
Plastic = 3
It is best to use the form to find the id for your specific case, as
these are code dependent.
STRING[] prop_words_to_cha integer array with material property word ids to change. If this
nge is a laminate offset, the id is 0.
1346 PCL Reference Manual
Materials
"D" = Delete
"+" = Add
"-" = Subtract
"*" = Multiply
"/" = Divide
"Info" = All
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Remarks:
The following preference setting may be used to modify the behavior of the GUI.
pref_env_set_string( "prop_modify_global_msg_level", "Warn" )
The default value is "Warn".
Common settings.pcl
The following preferences can be added to the user's settings.pcl file to control the Property forms. The
same preferences will also control the Materials/Modify/Global form.
pref_env_set_string( "prop_form_pset_sort_option", ".id" )
pref_env_set_integer( "prop_form_num_pset_lbox_rows", 10 )
pref_env_set_logical( "prop_form_pset_sort_use_case", FALSE )
pref_env_set_logical( "prop_form_pset_filter_use_case", TRUE )
These 2 are obsolete as the sort and filter widgets are now always shown.
pref_env_set_logical( "prop_form_pset_sort_option_show", TRUE )
pref_env_set_logical( "prop_form_pset_filter_show", TRUE )
Chapter 5: Property Assignment Functions 1347
Materials
Description:
Compress the list of material names. compress means to find duplicates and merge them while
replacing references.
Input:
INTEGER nFrom Number of names in fromNames.
STRING[ ]() fromNames List of from material names.
INTEGER nTo Number of names in toNames.
STRING[ ]() toNames List of to material names.
INTEGER nSigDigits Number of significant digits to use when comparing real
numbers.
LOGICAL deleteComp Flag whether to delete duplicates.
Load Cases
This section explains the functions that pertain to load cases.
Description:
This function creates a new load case.
Input:
STRING load_case_name[80] This value specifies the new load case name.
STRING load_case_type[31] This value specifies the load case type and can be set to either
Static or Time Dependent.
STRING load_case_desc[256] This value specifies the load case description.
STRING lbc_name[31]() This value specifies the load/BC set names to be associated
with this load case.
INTEGER priorities() This value specifies the load/BCs set priorities. The default is
0 or add otherwise. The priority value can range from 1 to the
number of load/BC sets, where 1 indicates the highest or top
priority.
STRING dynamic_name[80] This value specifies the dynamic load case name which was
used to generate the static load case at the specified dynamic
value.
REAL dynamic_value This value specifies the dynamic value used to evaluate this
static load case.
LOGICAL make_current This value is set to TRUE, if this load case should be made the
current load case. If this value is set to FALSE, this load case
will not be made the current load case.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
If the new load case created is the current load case then modify the display of Load/BC in the graphics
window.
This function can display a fatal popup message form with the following messages:
This function can display a query popup message form with the following message:
This function can display an information popup message form with the following message:
Example:
Description:
This function creates a new load case.
Input:
STRING lc_name[32] The name of the load case
STRING lc_desc[256] The load case description
STRING lcc_names[32]() Array of names of the load cases used in the new load case
REAL lcc_factors() Array of the scale factors used for the included load cases
LOGICAL make_current TRUE to make the load case current. Note: this should
always be set to FALSE.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Remarks:
None
1350 PCL Reference Manual
Load Cases
Description:
This function deletes a load case and can optionally delete the loads and boundary conditions
associated with the load case.
Input:
STRING load_case_name[] This value specifies the name of load case to be deleted.
LOGICAL delete_assoc_lbcs This value specifies, when set to TRUE, that any associated
Load/BCs are to be deleted. If this value is set to FALSE,
associated Load/BCs will not be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
If a Load/BC is deleted the graphical display of Load/BCs in the graphics window will be updated.
This function can display a fatal popup message form with the following messages:
This function can display an information popup message form with the following message:
This function can display a warning popup message form with the following message:
Example:
Description:
This function is used to delete a combination load case (Nastran SUBCOM).
Input:
STRING lc_name[32] The name of the load case
LOGICAL del_lbcs TRUE to delete the associated LBCs.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Remarks:
None
1352 PCL Reference Manual
Load Cases
Description:
This function modifies a load case in the database.
Input:
STRING load_case_name[80 This value specifies an existing load case name.
]
STRING new_name[80] This value specifies the new load case name.
STRING load_case_type[31] This value specifies the load case type and can be set to
either Static or Time Dependent.
STRING load_case_desc[25 This value specifies the load case description.
6]
STRING lbc_name[31]() This value specifies the load/BC set name to be
associated with this load case.
INTEGER priorities() This value specifies the load/BCs set priorities. The
default is 0 or add otherwise. The priority value can
range from 1 to the number of load/BC sets, where 1
indicates the highest or top priority.
STRING dynamic_name[80] This value specifies the dynamic load case name which
was used to generate the static load case at the specified
dynamic value. Not used in Release 1.
REAL dynamic_value This value specifies the dynamic value used to evaluate
this static load case. Not used in Release 1.
LOGICAL make_current This value is set to TRUE, if this load case should be
made the current load case. If this value is set to
FALSE, this load case will not be made the current load
case.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message
in the message database.
Remarks:
Chapter 5: Property Assignment Functions 1353
Load Cases
Description:
This function is used to modify a combination load case (Nastran SUBCOM).
Input:
STRING lc_name[32] The name of the load case
STRING lc_new_name[32] The new name of the load case
STRING lc_desc[256] The load case description
STRING lcc_names[32]() Array of names of the load cases used in the new load case
REAL lcc_factors() Array of the scale factors used for the included load cases
LOGICAL make_current TRUE to make the load case current. Note: this should
always be set to FALSE.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Remarks:
None
1354 PCL Reference Manual
Load Cases
loadcase_show (load_case_name)
Description:
This function shows the attributes of the selected load case.
Input:
STRING load_case_name[80] This value specifies the load case name to be shown.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function can display a fatal popup message form with the following messages:
Example:
Fields
This section explains the functions that pertain to fields..
Description:
This function creates a new field in the database.
Input:
STRING field_name[31] This value specifies the new field name.
STRING object_type[31] This value specifies the object type: Spatial, Non-
Spatial, Material, or Time Dependent.
INTEGER extrap_method This value specifies the extrapolation method: 1 = Use
closest table value, 2 = Linear extrapolation, and 3 =
Set value to zero.
STRING field_type[31] This value specifies the type: Scalar, Vector, or
Complex Scalar.
STRING coord_type[31] This value specifies the coordinate frame type: Real or
Parametric.
STRING coord_frame[31] This value specifies the coordinate frame. It is not used for
spatial parametric fields.
STRING geom_entity[31] This value specifies the geometric entity used for spatial
parametric fields.
STRING definition_type[31] This value specifies the definition: Function or Table.
INTEGER num_active_var This value specifies the number of active independent
variables or dimension.
STRING ind_variable_1[31] This value specifies the independent variable 1. For
Spatial: X, R, or C1. For Material: T. For Non-
Spatial: t, f, T, u, v, UD, fri, fmpd, or
fmpr. For Time Dependent: t. Note that fri, fmpd,
or fmpr must be used for complex-valued functions of
frequency. fri indicates that the complex terms are real-
imaginary; fmpd indicates magnitude-phase (degrees),
and fmpr, magnitude-phase (radians).
1356 PCL Reference Manual
Fields
This array contains the field values for all data points. It is
only applicable for tabular fields. Use a single zero if not
applicable. For real-valued fields its dimensions must be
len1 x len2 x len3, where len1, len2, and len3 are the
lengths of the arrays var1_values, var2_values, and
var3_values, respectively. For complex-valued fields its
dimensions must be 2 x len1 x len2 x len3, with all of the
first complex component terms preceding all second
component terms. That is, all reals precede all imaginaries
and all magnitudes precede all phases.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in
the message database.
Remarks:
This function can display a fatal popup message form with the following messages:
This function can display a query popup message form with the following message:
This function can display an information popup message form with the following message:
Notes:
Description:
This function creates a new Load/BC field in the database.
Input:
STRING field_name[31] This value specifies the new field name.
STRING entity_type[31] This value specifies the entity type: Node or Element.
STRING type[31] This value specifies the type: Scalar or Vector.
INTEGER num_entities This value specifies the number of entities in the field.
STRING entities[](num_entities)
This value specifies the names of the entities to be
associated with the field.
STRING values[](num_entities)
This value specifies an array of scalars or vectors,
depending on field type. If the <type> is Vector, either a
vector or a node ID may be specified.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function can display a fatal popup message form with the following messages:
This function can display a query popup message form with the following message:
This function can display an information message form with the following message:
Notes:
The interface limits the field_name[31] input to 31 characters.
Chapter 5: Property Assignment Functions 1359
Fields
Description:
This function creates a new Load/BC field in the database.
Input:
STRING field_name[31] This value specifies the new field name.
STRING object_type[] This value specifies the object type: Spatial or Non-
Spatial.
STRING entity_type[31] This value specifies the entity type: Node or Element.
STRING type[31] This value specifies the type: Scalar or Vector.
INTEGER num_entities This value specifies the number of entities in the field.
STRING entities[](num_entities)
This value specifies the names of the entities to be associated
with the field.
STRING dynamic_var[] This value specifies the dynamic variable: t for time,f for
frequency or for non-dynamic.
INTEGER extrap_method This value specifies the extrapolation method: 1 = Use
closest table value, 2 = Linear extrapolation, and 3 = Set
value to zero.
INTEGER num_steps This value specifies the number of dynamic steps. For Non-
Spatial only.
REAL steps(num_steps) This value specifies an array of dynamic step values. For
Non-Spatial only.
STRING values[](num_entities)
This value specifies an array of scalars or vectors, depending
on field type. If the <type> is Vector, either a vector or a
node ID may be specified.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
1360 PCL Reference Manual
Fields
Remarks:
This function can display a fatal popup message form with the following messages:
This function can display a query popup message form with the following message:
This function can display an information message form with the following message:
Description:
This function creates a new general field in the database.
Input:
STRING field_name[31] This value specifies the new field name.
INTEGER object_type This value specifies the object type id: 1 = Spatial, 2 =
Material, and 3 = Non-Spatial.
INTEGER field_method This value specifies the field method type and should always
be set to the value 5.
INTEGER extrap_method This value specifies the extrapolation method: 1 = Use
closest table value, 2 = Linear extrapolation, and 3 = Set
value to zero.
STRING coord_type[31] This value specifies the coordinate frame type: Real or
Parametric.
STRING coord_frame[31] This value specifies the coordinate frame.
STRING geom_entity[31] This value specifies the geometric entity used for parametric
field.
INTEGER num_active_var This value specifies the number of active independent
variables or dimension.
INTEGER ind_variable_1 This value specifies the first independent variable. See the
remarks below for more information.
INTEGER ind_variable_2 This value specifies the second independent variable. See the
remarks below for more information.
INTEGER ind_variable_3 This value specifies the third independent variable. See the
remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
The input value ind_variable_1, ind_variable_2, and ind_variable_3 can be set to the following values
1362 PCL Reference Manual
Fields
Spatial X 1
Y Direction Y 2
Z Direction Z 3
R Direction R 4
T Direction T 5
P Direction P 6
C1 Direction C1 7
C2 Direction C2 8
C3 Direction C3 9
Temperature T 10
Strain e 11
Strain Rate er 12
Time t 13
Frequency f 14
Radiosity RAD 15
This function can display a fatal popup message form with the following messages:
This function can display a query popup message form with the following message:
Example:
Description:
This function creates a term for a general field in the database.
Input:
STRING field_name[31] This value specifies an existing general field name.
INTEGER term_field_id This value specifies the term field id.
INTEGER term_type This value specifies the term type.
INTEGER term_id This value specifies the term id.
INTEGER data_length This value specifies the length of the data.
STRING data[] This value specifies the expression data.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
None.
Example:
Description:
This function creates a new FEM field in the database.
Input:
STRING field_name[31] This value specifies the new field name.
STRING group[31] This value specifies the name of the group that the results
apply to.
STRING type[31] This value specifies the type: Scalar or Vector.
INTEGER extrap_method This value specifies the extrapolation method: 1 = Use
closest table value, 2 = Linear extrapolation, and 3 =
Set value to zero.
STRING coord_frame[31] This value specifies the name of the coordinate frame to
be used. This value defaults to Coord 0.
INTEGER results_interp This value specifies the 3D interpolation of 2D results
flag: 0=interpolate points as-is, 1=apply 2D results
uniformly in the 1 direction of the new model, 2=apply
in 2 direction, and 3=apply in 3 direction.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in
the message database.
Remarks:
The extrap_method and results_interp are not used in the creation of the Field, but later in the
interpolation on the new model.
It is recommended that the results and current models both use the same coordinate frame. For more
complex interpolations experiment first with the simple model to establish a procedure.
This function can display a fatal popup message form with the following messages:
This function can display a query popup message form with the following message:
This function can display an information popup message form with the following message:
This function can display an acknowledge popup message form with the following message:
Chapter 5: Property Assignment Functions 1365
Fields
Notes:
Description:
This function creates a new Load/BC field in the database.
Input:
STRING field_name[31] This value specifies the new field name.
STRING entity_type[31] This value specifies the entity type: Node or
Element.
STRING type[31] This value specifies the type: Scalar or Vector.
INTEGER num_entities This value specifies the number of entities in the
field.
STRING entities[](num_entities)
This value specifies the names of the entities to be
associated with the field.
STRING values[](num_entities)
This value specifies an array of scalars or vectors,
depending on field type.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status
message in the message database.
Remarks:
This function can display a fatal popup message form with the following messages:
This function can display a query popup message form with the following message:
1366 PCL Reference Manual
Fields
This function can display an information message form with the following message:
Example:
Description:
This function deletes an existing field from the database.
Input:
INTEGER num_fields This value specifies the number of fields to be deleted.
STRING field_name[31](num_fields)
This value specifies the names of the fields to be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000127 The field entered does not exist.
13000184 The field is in use and cannot be deleted.
Remarks:
Example:
Description:
This function modifies an existing field in the database.
Input:
STRING field_name[31] This value specifies the name of the existing field to be
modified.
STRING new_name[31] This value specifies the new field name. This value
should be set to the same value specified as the input
value load_case_name if the field name is not to be
changed.
STRING object_type[31] This value specifies the object type: Spatial, Non-
Spatial, Material, or Time Dependent
INTEGER extrap_method This value specifies the extrapolation method: 1 = use
closest table value, 2 = linear extrapolation, and 3 = set
value to zero.
STRING type[31] This value specifies the type: Scalar, Vector, or
Complex Scalar.
STRING coord_type[31] This value specifies the coordinate frame type: Real
or Parametric.
STRING coord_frame[31] This value specifies the coordinate frame.
STRING geom_entity[31] This value specifies the geometric entity used for spatial
parametric field.
STRING definition_type[31] This value specifies the definition: Function or
Table.
INTEGER num_active_var This value specifies the number of active independent
variables or dimension.
1368 PCL Reference Manual
Fields
Remarks:
This function can display a fatal popup message form with the following messages:
This function can display an information message form with the following message:
Example:
Description:
This function modifies an existing Load/BC field in the database.
Input:
STRING field_name[31] This value specifies the name of existing field to be modified.
STRING new_name[31] This value specifies the new field name. This value should be set
to the same value specified as the input value load_case_name if
the field name is not to be changed.
STRING entity_type[31] This value specifies the entity type: Node or Element.
STRING type[31] This value specifies the type: Scalar or Vector.
INTEGER num_entities This value specifies the number of entities in the field.
STRING entities[](num_entities)
This value specifies the names of the entities in list processor
format.
STRING values[](num_entities)
This value specifies the one or three dimensional array values
depending on field type.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
This function can display a fatal popup message form with the following messages:
This function can display an information popup message form with the following message:
Example:
Description:
This function modifies an existing FEM field in the database.
Input:
STRING field_name[31] This value specifies the name of existing field to be
modified.
STRING new_name[31] This value specifies the new field name. Same as the
input value old_name if it is not to be changed.
STRING group[31] This value specifies the name of the group that results
apply to.
STRING type[31] This value specifies the type: Scalar or Vector.
INTEGER extrap_method This value specifies the extrapolation method: 1 = use
closest table value, 2 = linear extrapolation, and 3 = set
value to zero.
STRING coord_frame[31] This value specifies the name of the coordinate frame
to be used. This value defaults to Coord 0.
INTEGER results_interp This value specifies the 3D interpolation of 2D results
flag: 0=interpolate points as-is, 1=apply 2D results
uniformly in the 1 direction of the new model,
2=apply in 2 direction, and 3=apply in 3 direction.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message
in the message database.
Remarks:
This function can display a fatal popup message form with the following messages:
This function can display an information popup message form with the following message:
Example:
Description:
This function shows an existing field in tabular and XY Plot format.
Input:
STRING field_name[31] This value specifies the field name.
STRING ind_label[31] This value specifies an independent variable.
REAL ind_min This value specifies the minimum value of the independent
variable.
REAL ind_max This value specifies the maximum value of the independent
variable.
INTEGER ind_num_points This value specifies the number of points of the independent
variable.
REAL fixed1_min This value specifies the minimum value of the first fixed
variable.
REAL fixed1_max This value specifies the maximum value of the first fixed
variable.
INTEGER fixed1_num_points This value specifies the number of points of the first fixed
variable.
REAL fixed2_min This value specifies the minimum value of the second fixed
variable.
REAL fixed2_max This value specifies the maximum value of the second fixed
variable.
INTEGER fixed2_num_points This value specifies the number of points of the second fixed
variable.
LOGICAL existing_pts_flag This value uses the existing points flag. The value is set to
TRUE if the existing points should be used, and to FALSE if
the values are to be calculated from existing points. Always
set this value to FALSE for function fields.
LOGICAL post_xy_flag This value specifies the post XY plot flag. The value is set to
TRUE if the XY plot window displaying data is desired.
1374 PCL Reference Manual
Fields
INTEGER type_dep_val The use of this value depends on the field type. For vector
fields this value specifies the selected vector component- 1, 2,
3. For complex scalar fields this value specifies the tabular
and XY Plot output type: 1 for real-imaginary, 2 for
magnitude-phase (degrees), 3 for magnitude-phase (radians),
and 4 for magnitude (db)-phase (degrees), i.e. Bode plot data.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in the
message database.
Remarks:
If Post XY Plot flag is true, an XY Plot window is displayed. If the field is complex-valued, then two XY
plot windows are displayed.
This function can display a fatal popup message form with the following messages:
This function can display an acknowledge popup message form with the following message:
Example:
fields_show_lbc (field_name)
Description:
This function shows an existing Load/BC field in tabular format in a spreadsheet form.
Input:
STRING field_name[31] This value specifies the field name.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is an internal status condition. There is no corresponding status message in
the message database.
Remarks:
This function can display a fatal popup message form with the following message:
Example:
6 Results Postprocessing
Functions
Introduction 1378
Results Database Functions 1379
Results Utility Functions 1382
Results Data Registers 1458
Data Register Definition Functions 1460
Data Register Query Functions 1481
Data Register Operator Functions 1498
Direct Results Access 1501
Results Display Manager 1504
Plot Tool Creation and Modification Functions 1505
Plot Tool Manipulation Functions 1527
Animation Functions 1536
Quick Plot Functions 1552
Plot Tool Query Functions 1561
Results Template Functions 1573
Results Plot Sets 1590
1378 PCL Reference Manual
Introduction
Introduction
This chapter documents functions that are used by the Results switch bar form.
This chapter presents function descriptions in five separate sections:
Results Utility Functions This section describes results utility functions used to extract results
data and attributes of results data from the database.
Results Data Registers This section describes the use of registers by the functions used to
maintain both results data and the methods used to obtain, manipulate,
and display the results data.
Data Register Definition This section describes the functions used to specify where data is to be
Functions obtained, how data is to be manipulated, how registers may be
combined, and define any location associations that finite element
model entities have with results data.
Data Register Query This section describes the functions used to obtain information about
Functions the contents of registers.
Data Register Operator This section describes the functions that are used to manipulate the
Functions contents of registers.
Results Display Manager This section describes the use of the results display manager and how
it is functions used to display results data.
Plot Tool Creation and This section describes functions that are used to create and modify
Modification Functions display tools.
Plot Tool Manipulation This section describes functions that are used to manipulate display
Functions tools.
Animation Functions This section describes functions that are used to animate the display of
results data.
Plot Tool Query Functions This section describes functions that are used to retrieve information
about currently defined display tools.
Chapter 6: Results Postprocessing Functions 1379
Results Database Functions
Description:
Create a loadcase.
Input:
STRING name The name of the load case.
INTEGER type The load case code.
STRING description The load case description.
Output:
INTEGER loadcase_id The loadcase id.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Notes:
The "type" can be set to the following values:
STATIC_ID 1
TIME_DEPENDENT_ID 2
FREQ_DEPENDENT_ID 3
COMBINATION_ID 4
The "description" can be set to the following values:
STATIC "Static"
TIME_DEPENDENT "Time Dependent"
FREQ_DEPENDENT "Freq Dependent"
COMBINATION "Combination"
Remarks:
None
Example:
None
1380 PCL Reference Manual
Results Database Functions
Description:
Creates a new result type.
Input:
STRING pri_label The primary result label.
STRING sec_label The secondary result label.
INTEGER data_type The data type code:
scalar
vector
tensor
INTEGER num_form The numerical form code.
real
imaginary
complex mag
complex phase
complex type
complex real
complex angle
STRING description[ 80 ] The results description.
INTEGER unit_code The unit code. Should be set to 0.
Output:
INTEGER result_type The result type created.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Remarks:
None
Chapter 6: Results Postprocessing Functions 1381
Results Database Functions
Example:
None
1382 PCL Reference Manual
Results Utility Functions
Description:
This function retrieves the title for a specified loadcase identifier.
Input:
INTEGER id This value specifies the loadcase identifier.
Output:
STRING title[80] This value returns the loadcase title.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000052 Load case not found.
Remarks:
None.
Example:
Description:
This function retrieves the id for a specified loadcase title.
Input:
STRING title[80] This value specifies the loadcase title.
Output:
INTEGER id This value returns the loadcase identifier.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000052 Load case not found.
Remarks:
None.
Example:
Description:
This function retrieves the title for a specified loadcase and subcase identifier. It returns the title of a
subcase excluding any extension added to the name to distinguish it, in the GUI, from other subcases
with the same name.If you want to keep the name extensions that Patran adds to the loadcase and
subcase identifier, use the function res_data_get_subcase_name, 1491.
Input:
INTEGER lcid This value specifies the loadcase identifier.
INTEGER subid This value specifies the subcase identifier.
Output:
STRING title[31] This value returns the subcase title.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000053 Sub case not found.
Remarks:
None.
Example:
Description:
This function retrieves the subcase identifier for a specified loadcase identifier, subcase title.
Input:
INTEGER lcid This value specifies the loadcase identifier.
STRING title[31] This value specifies the subcase title.
Output:
INTEGER subid This value returns the subcase identifier.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000053 Sub case not found.
Remarks:
None.
Example:
Description:
This function retrieves the label for a specified primary result identifier.
Input:
INTEGER primary_id This value specifies the primary result identifier.
Output:
STRING label[80] This value returns the primary result label.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
13000054 Result case not found.
Remarks:
1386 PCL Reference Manual
Results Utility Functions
None.
Example:
Description:
This function retrieves the identifier for a specified primary result label.
Input:
STRING label[80] This value specifies the primary result label.
Output:
INTEGER primary_id This value returns the primary result identifier.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
13000054 Result case not found.
Remarks:
None.
Example:
Description:
This function retrieves the label for a specified secondary result identifier.
Input:
INTEGER primary_id This value specifies the primary results identifier.
INTEGER secondary_id This value specifies the secondary result identifier.
Output:
STRING label[80] This value returns the secondary result label.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function retrieves the identifier for a specified secondary result label.
Input:
INTEGER primary_id This value specifies the primary result identifier.
STRING label[80] This value specifies the secondary result label.
Output:
INTEGER secondary_id This value returns the secondary result identifier.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function will update isometric mesh parameters in the database.
Input:
REAL smooth_factor This value specifies the weighting factor for smoothing a
mesh. This value can range from 0.0 to 1.0.
INTEGER maximum_cycles This value specifies the maximum number of smoothing
cycles.
REAL acceleration_factor This value specifies the smoothing acceleration factor
which ranges from 0.0 to 1.0.
REAL termination_factor This value specifies the smoothing termination factor
which ranges from 0.0 to 0.2.
INTEGER triangular_surf_mesh This value specifies the mesh pattern for surfaces with a
triangular shape and can have a value of either 1 or 2.
INTEGER triangle_rectangle This value specifies the triangular element pattern for
rectangular surfaces and can have a value that ranges from
1 to 4.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
13000004 Duplicate entry exists in table
13000007 An unspecified database error occurred
13000047 Mesh not found
Remarks:
The input values to this function are not range checked. Calling this function with out of range values
will cause problems with functions that make use of this information from the database.
Example:
None.
1390 PCL Reference Manual
Results Utility Functions
Description:
This function will extract the internal element position identifiers for the results data associated with a
list of elements.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier.
STRING elem_list[] This value specifies a list of elements for which results are
extracted.
Output:
INTEGER count This value returns the number of returned element
identifiers.
INTEGER ids(VIRTUAL) This value returns the list of element identifiers.
INTEGER npos(VIRTUAL) This value returns the number of element positions per
element.
INTEGER posids(VIRTUAL) This value returns all of the element position identifiers for
the specified elements.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500005 No Elements are found for the specified result matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination specified
cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500009 No results are found in the database matching the specified Ids.
4500014 An error has occurred interpreting the input List string.
4500017 The specified operation is not valid.
13000054 Result case not found.
Chapter 6: Results Postprocessing Functions 1391
Results Utility Functions
Remarks:
The results data from which the information is extracted will be held in memory for further operations.
Only one result is held in memory at a time.
The output values ids and npos will be allocated with the number of offsets defined by the output value
count.
The output value posids will be allocated with the number of offsets defined by the sum of all of entries
in the output value npos.
This function can display a warning popup message form with the following message:
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
Example:
Description:
This function will extract the internal element position location for the results data associated with an
element identifier.
Input:
INTEGER elem_id This value specifies the element identifier.
INTEGER param_flag This value specifies the setting of the parameter flag:
0=XYZ global coordinates and 1=element
parametric coordinates.
INTEGER epos_id This value specifies the element position identifier.
Output:
REAL location(4) This value returns the XYZ or element parametric
coordinates.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
4500008 The input Location string is invalid.
13000021 Element not found.
Remarks:
This function can display an information popup message form with the following messages:
16000001Error code %I% occurred in %A%.
16000002Called from %A%.
30001425Notice: %I% interpolants lie off the field.
30001437An attempt was made to average nodal values for an element. All of the element nodes were
not found for %I% elements.
This function can display a warning popup message form with the following messages:
38000199WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing
surface) of %7.5f. The design build gap is %7.5f. Automatic gap fill invoked!
OR
WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing surface)
of %7.5f. The design build gap is %7.5f. Delete and Rebuild the Composite Trim Surface!
Chapter 6: Results Postprocessing Functions 1393
Results Utility Functions
OR
ERROR -- Composite Trim Surface Evaluator cannot compute a point on surface! The problem is a
vertical surface. Check the geometry, change view orientation, Delete and Rebuild the Composite Trim
Surface!
30001424Routine to locate points in elements did not converge for %I% interpolants.
This function can display a fatal popup message form with the following messages:
13000088Preference not found.
16000201Database error for item %I%: %A%.
30001061Field %A% is disassociated with geometry entity and unusable unless a new geometry entity
is provided.
38000136CompTrimSurface processor cannot locate surface with LABEL=%I% -- This is a database
FAILURE! -- Delete and Rebuild the CompTrim Surface.
Example:
Description:
This function extracts information about the specified results data.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase identifier,
primary result identifier, secondary result identifier, and layer
identifier.
Output:
STRING title[80](3) This value returns the title of the current result.
INTEGER nres This value returns the total number of results.
INTEGER data_type This value returns the data type. Valid values are: 1=scalar,
2=vector, and 3=tensor.
INTEGER assoc This value returns the association type. Valid values are:
1=nodal and 2=element.
INTEGER resloc This value returns the results location. Valid values are:
1=centroidal, 2=nodal, and 3=gauss point.
LOGICAL cidflag This value returns TRUE if the results are defined in a non-
global system.
INTEGER minloc(2,6) This value returns the identifier and location for each
minimum result component. The location is used only for
multiple element results.
INTEGER maxloc(2,6) This value returns the identifier and location for each
maximum result component. The location is used only for
multiple element results.
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message
in the message database.
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500005 No Elements are found for the specified result matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination
specified cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
Chapter 6: Results Postprocessing Functions 1395
Results Utility Functions
4500009 No results are found in the database matching the specified Ids.
13000054 Result case not found.
13000071 Result case type not found.
13000086 No Records Found.
13000210 The system is out of virtual memory.
Remarks:
The results data from which the information is extracted will be held in memory for further operations.
Only one result is held in memory at a time.
This function can display a warning popup message form with the following message:
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
Example:
res_utl_clear_result ()
Description:
This function clears any previously used results data from memory.
Input:
None.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully.
Error Conditions:
None.
Remarks:
None.
Example:
Description:
This function returns a list of the identifiers for which the specified results exist.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier.
Output:
STRING id_list[VIRTUAL] This value returns a list of the identifiers for which the
specified results exist.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in
the message database.
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500005 No Elements are found for the specified result matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination
specified cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500009 No results are found in the database matching the specified Ids.
13000054 Result case not found.
13000071 Result case type not found.
13000086 No Records Found.
13000210 The system is out of virtual memory.
14000001 LpGetHeapSpace: Allocated heapspace is exhausted.
14000201 Invalid output string specified for call.
Remarks:
The specified result will be held in memory for further operations. Only one result is held in memory at
a time.
This function can display a warning popup message form with the following message:
Chapter 6: Results Postprocessing Functions 1397
Results Utility Functions
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
Example:
Description:
This function returns the result type for the specified results.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier.
Output:
INTEGER result_type This value returns the result type. Valid values are:
1=Scalar, 2=Vector, and 3=Tensor.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
4500005 No Elements are found for the specified result matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination
specified cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500009 No results are found in the database matching the specified Ids.
13000054 Result case not found.
13000071 Result case type not found.
13000210 The system is out of virtual memory.
Remarks:
None.
Example:
Description:
This function returns the coordinate frame identifiers used for the result defined at the specified node
or element locations.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier.
INTEGER result_type This value specifies the type: 1=node, and 2=element.
INTEGER nids This value specifies the number of identifiers.
INTEGER ids(nids) This value specifies node or element identifiers.
Output:
INTEGER cids() This value returns a list of coordinate frame identifiers
in which the results specified are oriented. Valid values
are: -1=element local and 0=global.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in
the message database.
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500004 No Nodes found in the database matching the input list.
4500005 No Elements found in the database matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination
specified cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500009 No results are found in the database matching the specified Ids.
4500016 The input list type is not valid.
13000054 Result case not found.
13000071 Result case type not found.
13000086 No Records Found.
13000210 The system is out of virtual memory.
Chapter 6: Results Postprocessing Functions 1399
Results Utility Functions
Remarks:
The specified result will be held in memory for further operations. Only one result is held in memory at
a time.
This function can display a warning popup message form with the following message:
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
Example:
Description:
This function extracts the specified results data from the database.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier.
STRING node_list[] This value specifies a list of nodes for which to extract
results.
STRING derivation[10] This value specifies the derivation specifier if the
results are to be derived. A value of null will leave the
result as is. See the remarks below for more
information.
STRING cid[] This value specifies the coordinate system for
vector/tensor transformations. A null string is used to
leave the coordinate frame identifier as is.
Output:
INTEGER data_type This value returns the data type. Valid values are:
1=scalar, 2=vector, and 3=tensor.
INTEGER nres This value returns the number of returned node
identifiers.
INTEGER ids(VIRTUAL) This value returns a list of node identifiers.
REAL results(VIRTUAL) This value returns all of the results at the specified
nodes.
INTEGER minloc(6) This value returns the array offsets for each minimum
result component in the output value results.
INTEGER maxloc(6) This value returns the array offsets for each maximum
result component in the output value results.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message
in the message database.
4500002 An error has occurred calculating a nodal averaged result.
Chapter 6: Results Postprocessing Functions 1401
Results Utility Functions
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500004 No Nodes found in the database matching the input list.
4500005 No Elements found in the database matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination
specified cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500009 No results are found in the database matching the specified Ids.
4500010 The derivation specified in invalid.
4500011 A error has occurred extrapolating this result to the element nodes.
4500014 An error has occurred interpreting the input List string.
4500015 The specified Coordinate Frame does not exist.
4500018 The Coordinate Frame List is not valid.
13000054 Result case not found.
13000056 Coordinate frame not found.
13000071 Result case type not found.
13000085 Cursor not open.
13000086 No Records Found.
13000117 The query specified has completed.
13000210 The system is out of virtual memory.
14000281 LpExpandPclVariables: Virtual memory is full.
14000298 LpPicklistDecoder: Parse error.
14000299 LpPicklistDecoder: Memory is exhausted.
14000302 LpPicklistDecoderWithLookup: Memory is exhausted.
Remarks:
The specified result will be held in memory for further operations. Only one result is held in memory at
a time.
This function will perform extrapolation and averaging as necessary when element based results are
requested.
The result data type returned will be determined by the input value derivation.
The output value ids will be allocated with the number of offsets defined by the output value nres.
The output value results will be allocated as a two dimensional array where the number of offsets in the
first dimension of the array will be returned by the output value nres. The number of offsets in the second
dimension is dependent on the input value derivation. The second dimension of the output value results
1402 PCL Reference Manual
Results Utility Functions
will be set as follows: If the input value derivation specifies a tensor to scalar or vector to scalar
operation there will be 1 offset. If the input value derivation specifies a tensor to vector operation there
will be 3 offsets.
Vector or tensor results will be transformed to the alternate coordinate frame identifier if specified.
The input value derivation can have the following values:
:
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
This function can display an information popup message form with the following messages:
16000001Error code %I% occurred in %A%.
16000002Called from %A%.
30001425Notice: %I% interpolants lie off the field.
30001437An attempt was made to average nodal values for an element. All of the element nodes were
not found for %I% elements.
This function can display a warning popup message form with the following messages:
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
38000199WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing
surface) of %7.5f. The design build gap is %7.5f. Automatic gap fill invoked!
OR
WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing surface)
of %7.5f. The design build gap is %7.5f. Delete and Rebuild the Composite Trim Surface!
Chapter 6: Results Postprocessing Functions 1403
Results Utility Functions
OR
ERROR -- Composite Trim Surface Evaluator cannot compute a point on surface! The problem is a
vertical surface. Check the geometry, change view orientation, Delete and Rebuild the Composite Trim
Surface!
30001424Routine to locate points in elements did not converge for %I% interpolants.
This function can display a fatal popup message form with the following messages:
13000088Preference not found.
16000201Database error for item %I%: %A%.
30001061Field %A% is disassociated with geometry entity and unusable unless a new geometry entity
is provided.
38000136CompTrimSurface processor cannot locate surface with LABEL=%I% -- This is a database
FAILURE! -- Delete and Rebuild the CompTrim Surface.
Example:
Description:
This function extracts the specified results data from the database.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier.
STRING node_list[] This value specifies a list of nodes for which to extract
results.
STRING derivation[10] This value specifies the derivation specifier if the
results are to be derived. A value of null will leave the
result as is. See the remarks below for more
information.
STRING cid[] This value specifies the coordinate system for
vector/tensor transformations. A null string is used to
leave the coordinate frame identifier as is.
STRING avg_method[] This value specifies the averaging method to be used.
STRING avg_domain[] This value specifies the averaging domain to be used.
STRING extrap_method[] This value specifies the extrapolation method to be
used.
STRING complex_form[] This value specifies the form to be used for complex
numbers.
REAL complex_angle This value is used with the complex results when the
complex_form is Angle.
Output:
INTEGER data_type This value returns the data type. Valid values are:
1=scalar, 2=vector, and 3=tensor.
INTEGER nres This value returns the number of returned node
identifiers.
INTEGER ids(VIRTUAL) This value returns a list of node identifiers.
REAL results(VIRTUAL) This value returns all of the results at the specified
nodes.
Chapter 6: Results Postprocessing Functions 1405
Results Utility Functions
INTEGER minloc(6) This value returns the array offsets for each minimum
result component in the output value results.
INTEGER maxloc(6) This value returns the array offsets for each maximum
result component in the output value results.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in
the message database.
4500002 An error has occurred calculating a nodal averaged result.
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500004 No Nodes found in the database matching the input list.
4500005 No Elements found in the database matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination
specified cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500009 No results are found in the database matching the specified Ids.
4500010 The derivation specified in invalid.
4500011 A error has occurred extrapolating this result to the element nodes.
4500014 An error has occurred interpreting the input List string.
4500015 The specified Coordinate Frame does not exist.
4500018 The Coordinate Frame List is not valid.
13000054 Result case not found.
13000056 Coordinate frame not found.
13000071 Result case type not found.
13000085 Cursor not open.
13000086 No Records Found.
13000117 The query specified has completed.
13000210 The system is out of virtual memory.
14000281 LpExpandPclVariables: Virtual memory is full.
14000298 LpPicklistDecoder: Parse error.
14000299 LpPicklistDecoder: Memory is exhausted.
14000302 LpPicklistDecoderWithLookup: Memory is exhausted.
1406 PCL Reference Manual
Results Utility Functions
Remarks:
The specified result will be held in memory for further operations. Only one result is held in memory at
a time.
This function will perform extrapolation and averaging as necessary when element based results are
requested.
The result data type returned will be determined by the input value derivation.
The output value ids will be allocated with the number of offsets defined by the output value nres.
The output value results will be allocated as a two-dimensional array where the number of offsets in the
first dimension of the array will be returned by the output value nres. The number of offsets in the second
dimension is dependent on the input value derivation. The second dimension of the output value results
will be set as follows: If the input value derivation specifies a tensor to scalar or vector to scalar
operation there will be 1 offset. If the input value derivation specifies a tensor to vector operation there
will be 3 offsets.
Vector or tensor results will be transformed to the alternate coordinate frame identifier if specified.
The input value derivation can have the following values:
:
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
The input value avg_method can have one of the following values:
DeriveAverage, AverageDerive, Difference, or Sum
The input value avg_domain can have one of the following values:
Chapter 6: Results Postprocessing Functions 1407
Results Utility Functions
Example:
INTEGER i, nres, dtype, minloc(6), maxloc(6), status
INTEGER nids(VIRTUAL)
REAL results(VIRTUAL)
/* Extract von Mises nodal results from the element tensor result with Loadcase
ID=2, Subcase ID=1,Primary Res ID=3, Secondary Res ID=1, Layer ID=1 */
status = res_utl_extract_nodal_results( [2,1,3,1,1], "Node 1:#", @
"vonm", "", dtype, nres, nids, results, minloc, maxloc )
IF( status != 0 ) THEN @ /* print message if error */
msg_to_form( status, 4, 0, 0, 0., "" )
ELSE
/* print out min/max */
i = minloc(1)
ui_writec(" Min Id= %d, von Mises Stress= %g", ids(i), results(i) )
i = maxloc(1)
ui_writec(" Max Id= %d, von Mises Stress= %g", ids(i), results(i) )
END IF
Chapter 6: Results Postprocessing Functions 1409
Results Utility Functions
Description:
This function extracts the specified results data from the database.
Input:
INTEGER nlcs This value specifies the number of result cases to be
extracted.
INTEGER lcids(nlcs) This value specifies the loadcase identifiers.
INTEGER subids(nlcs) This value specifies the subcase identifiers.
INTEGER result_ids(3) This value specifies the primary result identifier,
secondary result identifier, and layer identifier.
STRING node_list[] This value specifies a list of nodes at which to extract
results.
STRING derivation[10] This value specifies the derivation specifier if the results
are to be derived. A value of null will leave the result as
is. See the remarks below for more information.
STRING cid[] This value specifies the coordinate system for
vector/tensor transformations. A null string is used to
leave the coordinate frame identifier as is.
Output:
INTEGER data_type This value returns the data type. Valid values are:
1=scalar, 2=vector, and 3=tensor.
INTEGER nres This value returns the number of node identifiers.
INTEGER ids(VIRTUAL) This value returns a list of node identifiers.
REAL results(VIRTUAL) This value returns all of the results at the specified nodes
for each result case.
INTEGER minloc(VIRTUAL) This value returns the load case or subcase identifier array
offsets for each node minimum in the output value results.
INTEGER maxloc(VIRTUAL) This value returns the load case or subcase identifier array
offsets for each maximum node in the output value results.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
1410 PCL Reference Manual
Results Utility Functions
Remarks:
The specified result will be held in memory for further operations. Only one result is held in memory at
a time.
This function will perform extrapolation and averaging as necessary when element based results are
requested.
The result data type returned will be determined by the input value derivation.
The output value ids will be allocated with the number of offsets defined by the output value nres.
Chapter 6: Results Postprocessing Functions 1411
Results Utility Functions
The output value results will be allocated as a three dimensional array where the number of offsets in the
first dimension of the array will be set by the input value nlcs. The number of offsets in the second
dimension of the array will be set by the output value nres. The number of offsets in the third dimension
is dependent on the input value derivation. The third dimension of the output value results will be set as
follows: If the input value derivation specifies a tensor to scalar or vector to scalar operation there
will be 1 offset. If the input value derivation specifies a tensor to vector operation there will be 3
offsets.
The output values minloc and maxloc will be allocated as two dimensional arrays where the number of
offsets in the first dimension of the array will be set by the output value nres. The number of offsets in
the second dimension is dependent on the input value derivation. The second dimension of the output
values minloc and maxloc will be set as follows: If the input value derivation specifies a tensor to scalar
or vector to scalar operation there will be 1 offset. If the input value derivation specifies a tensor to
vector operation there will be 3 offsets.
Vector or tensor results will be transformed to the alternate coordinate frame identifier if specified.
Minimum and maximum subcase locations will be determined for each node specified.
The input value derivation can have the following values:
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
This function can display an information popup message form with the following messages:
16000001Error code %I% occurred in %A%.
1412 PCL Reference Manual
Results Utility Functions
Description:
This function extracts the specified results data from the database.
Input:
INTEGER nlcs This value specifies the number of result cases to be
extracted.
INTEGER lcids(nlcs) This value specifies the loadcase identifiers.
INTEGER subids(nlcs) This value specifies the subcase identifiers.
INTEGER result_ids(3) This value specifies the primary result identifier,
secondary result identifier, and layer identifier.
STRING node_list[] This value specifies a list of nodes at which to extract
results.
STRING derivation[10] This value specifies the derivation specifier if the
results are to be derived. A value of null will leave the
result as is. See the remarks below for more
information.
STRING cid[] This value specifies the coordinate system for
vector/tensor transformations. A null string is used to
leave the coordinate frame identifier as is.
STRING avg_method[] This value specifies the averaging method to be used.
STRING avg_domain[] This value specifies the averaging domain to be used.
STRING extrap_method[] This value specifies the extrapolation method to be
used.
STRING complex_form[] This value specifies the form to be used for complex
numbers.
REAL complex_angle This value is used with complex results when the
complex_form is Angle.
Output:
INTEGER data_type This value returns the data type. Valid values are:
1=scalar, 2=vector, and 3=tensor.
INTEGER nres This value returns the number of node identifiers.
INTEGER ids(VIRTUAL) This value returns a list of node identifiers.
1414 PCL Reference Manual
Results Utility Functions
REAL results(VIRTUAL) This value returns all of the results at the specified
nodes for each result case.
INTEGER minloc(VIRTUAL) This value returns the load case or subcase identifier
array offsets for each node minimum in the output
value results.
INTEGER maxloc(VIRTUAL) This value returns the load case or subcase identifier
array offsets for each maximum node in the output
value results.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message
in the message database.
4500002 An error has occurred calculating a nodal averaged result.
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500004 No Nodes found in the database matching the input list.
4500005 No Elements found in the database matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination
specified cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500009 No results are found in the database matching the specified Ids.
4500010 The derivation specified in invalid.
4500011 A error has occurred extrapolating this result to the element nodes.
4500014 An error has occurred interpreting the input List string.
4500015 The specified Coordinate Frame does not exist.
4500018 The Coordinate Frame List is not valid.
13000054 Result case not found.
13000056 Coordinate frame not found.
13000071 Result case type not found.
13000085 Cursor not open.
13000086 No Records Found.
13000117 The query specified has completed.
13000210 The system is out of virtual memory.
14000281 LpExpandPclVariables: Virtual memory is full.
Chapter 6: Results Postprocessing Functions 1415
Results Utility Functions
Remarks:
The specified result will be held in memory for further operations. Only one result is held in memory at
a time.
This function will perform extrapolation and averaging as necessary when element based results are
requested.
The result data type returned will be determined by the input value derivation.
The output value ids will be allocated with the number of offsets defined by the output value nres.
The output value results will be allocated as a three-dimensional array where the number of offsets in the
first dimension of the array will be set by the input value nlcs. The number of offsets in the second
dimension of the array will be set by the output value nres. The number of offsets in the third dimension
is dependent on the input value derivation. The third dimension of the output value results will be set as
follows: If the input value derivation specifies a tensor to scalar or vector to scalar operation there
will be 1 offset. If the input value derivation specifies a tensor to vector operation there will be 3
offsets.
The output values minloc and maxloc will be allocated as two-dimensional arrays where the number of
offsets in the first dimension of the array will be set by the output value nres. The number of offsets in
the second dimension is dependent on the input value derivation. The second dimension of the output
values minloc and maxloc will be set as follows: If the input value derivation specifies a tensor to scalar
or vector to scalar operation there will be 1 offset. If the input value derivation specifies a tensor to
vector operation there will be 3 offsets.
Vector or tensor results will be transformed to the alternate coordinate frame identifier if specified.
Minimum and maximum subcase locations will be determined for each node specified.
The input value derivation can have the following values:
1416 PCL Reference Manual
Results Utility Functions
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
38000199WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing
surface) of %7.5f. The design build gap is %7.5f. Automatic gap fill invoked!
OR
WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing surface)
of %7.5f. The design build gap is %7.5f. Delete and Rebuild the Composite Trim Surface!
OR
ERROR -- Composite Trim Surface Evaluator cannot compute a point on surface! The problem is a
vertical surface. Check the geometry, change view orientation, Delete and Rebuild the Composite Trim
Surface!
30001424Routine to locate points in elements did not converge for %I% interpolants.
This function can display a fatal popup message form with the following messages:
13000088Preference not found.
16000201Database error for item %I%: %A%.
30001061Field %A% is disassociated with geometry entity and unusable unless a new geometry entity
is provided.
38000136CompTrimSurface processor cannot locate surface with LABEL=%I% -- This is a database
FAILURE! -- Delete and Rebuild the CompTrim Surface.
Example:
INTEGER i, j, nres, dtype, minloc(VIRTUAL), maxloc(VIRTUAL), status
INTEGER nids(VIRTUAL), subids(5) = 1,2,3,4,5
REAL results(VIRTUAL)
/* Extract von Mises nodal results from the element tensor result with Loadcases
ID=2, Subcases ID=1 thru 5,Primary Res ID=3, Secondary Res ID=1, Layer ID=1 */
status = res_utl_extract_nodal_results( 5,[2,2,2,2,2],subids, @
[3,1,1], "Node 1:#", "vonm", "", dtype, nres, nids, results, @
minloc, maxloc )
IF( status != 0 ) THEN /* print message if error */
msg_to_form( status, 4, 0, 0, 0., "" )
ELSE
/* print out min/max subcase/value for each node */
FOR( i = 1 TO nres )
ui_writec(" Id= %d, Min Subcase= %d, von Mises Stress= %g", @
ids(i), subids(minloc(i)), results(minloc(i),i) )
ui_writec(" Id= %d, Max Subcase= %d, von Mises Stress= %g", @
ids(i), subids(maxloc(i)), results(maxloc(i),i) )
END FOR
END IF
1418 PCL Reference Manual
Results Utility Functions
Description:
This function adds the specified results data to the database.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier. The primary and result
identifiers are not used as inputs by this function. This
value is used as both an input and an output to the
function and would be passed by the calling function as
a single argument.
STRING primary_title[80] This value specifies the primary result title.
STRING secondary_title[80] This value specifies the secondary result title.
INTEGER nids This value specifies the number of input node
identifiers.
INTEGER ids(nids) This value specifies the node identifiers for the results.
STRING cid_list[] This value specifies the alternate coordinate system for
the vector or tensor results. A null string is used for the
global coordinate system.
INTEGER data_type This value specifies the data type to use: 1=scalar,
2=vector, and 3=tensor.
REAL results() This value specifies all of the results at the specified
nodes.
Output:
INTEGER result_ids(5) This value returns the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier. The load case, subcase,
and layer identifiers are not used as output values by
this function. The primary and result identifiers are
used as outputs by this function. This value is used as
both an input and an output to the function and would
be passed by the calling function as a single argument.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
Chapter 6: Results Postprocessing Functions 1419
Results Utility Functions
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500004 No Nodes found in the database matching the input list.
4500007 The specified Layer Id is not associated with the specified result.
4500015 The specified Coordinate Frame does not exist.
4500018 The Coordinate Frame List is not valid.
13000054 Result case not found.
Remarks:
This function expects that a load case or subcase and a layer position already exist.
The value result_ids will be used as both an input and an output value.
The primary and secondary identifiers returned by the input and output value result_ids are based on the
input values primary_title and secondary_title. These input values primary_title and secondary_title will
either match up with existing primary and secondary results or new ones will be generated.
Example:
Description:
This function extracts the specified results data from the database.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier.
STRING elem_list[] This value specifies a list of elements for which to extract
results.
STRING derivation[10] This value specifies the derivation specifier if the results
are to be derived. A value of null will leave the result as
is. See the remarks below for more information.
STRING location[] This value specifies the location of the coordinate frame
identifier: "", "A" = axis, "C" = centroid, and "N" = nodal.
STRING cid[] This value specifies the coordinate system for vector and
tensor transformations. A null string is used to leave the
coordinate frame identifier as is. Valid Coordinate sytem
strings types are: "Global", "Material", "IJK",
"Nodal", "Coord", "ResCoord", "Bisector",
"CQUAD8", "Unknown", "Default", "LocalDir",
"AsIs". For a more detailed explanation of Coordinate
Systems in Patran, please see Coordinate Systems
(p. 295) in the Results Postprocessing
Output:
INTEGER data_type This value returns the data type. Valid values are:
1=scalar, 2=vector, and 3=tensor.
INTEGER resloc This value returns the result location. Valid values are:
1=centroid, 2=nodal, 3=multiple, and 4=mixed.
INTEGER nres This value returns the number of returned element
identifiers.
INTEGER ids(VIRTUAL) This value returns a list of element identifiers.
INTEGER nresults(VIRTUAL) This value returns the number of results per element.
REAL results(VIRTUAL) This value returns all of the results at the specified
element locations.
INTEGER minloc(12) This value returns the array offsets for each minimum
result component in the output value results.
Chapter 6: Results Postprocessing Functions 1421
Results Utility Functions
INTEGER maxloc(12) This value returns the array offsets for each maximum
result component in the output value results.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in
the message database.
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500005 No Elements are found for the specified result matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination
specified cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500008 The input Location string is invalid.
4500009 No results are found in the database matching the specified Ids.
4500010 The derivation specified in invalid.
4500011 A error has occurred extrapolating this result to the element nodes.
4500014 An error has occurred interpreting the input List string.
4500015 The specified Coordinate Frame does not exist.
4500018 The Coordinate Frame List is not valid.
13000054 Result case not found.
13000056 Coordinate frame not found.
13000071 Result case type not found.
13000085 Cursor not open.
13000086 No Records Found.
13000117 The query specified has completed.
13000210 The system is out of virtual memory.
14000281 LpExpandPclVariables: Virtual memory is full.
14000298 LpPicklistDecoder: Parse error.
14000299 LpPicklistDecoder: Memory is exhausted.
14000302 LpPicklistDecoderWithLookup: Memory is exhausted.
Remarks:
This function will perform extrapolation and averaging as necessary when element based results are
requested.
1422 PCL Reference Manual
Results Utility Functions
The result data type returned will be determined by the input value derivation.
Results may be extracted either at element centroids, element nodes or as found.
The value in the output values minloc or maxloc are not the direct index into the output value results. Use
the following formula to obtain the index into the output value results using the values in the output
values minloc or maxloc: res_index = loc(2,i) + nresults(1) + nresults(2) + ... + nresults(loc(1,i)-1). If the
element results are centroidal this will become: res_index = loc(1,i).
The specified result will be held in memory for further operations. Only one result is held in memory at
a time.
The output value ids will be allocated with the number of offsets defined by the output value nres.
The output value results will be allocated as a two dimensional array where the number of offsets in the
first dimension of the array will be set by the sum of all of the values in the output value nresults. The
number of offsets in the second dimension is dependent on the input value derivation. The second
dimension of the output value results will be set as follows: If the input value derivation specifies a
tensor to scalar or vector to scalar operation there will be 1 offset. If the input value derivation
specifies a tensor to vector operation there will be 3 offsets.
The output values minloc and maxloc will be allocated as two dimensional arrays where the number of
offsets in the first dimension of the array will be set by the output value nres. The number of offsets in
the second dimension is dependent on the input value derivation. The second dimension of the output
values minloc and maxloc will be set as follows: If the input value derivation specifies a tensor to scalar
or vector to scalar operation there will be 1 offset. If the input value derivation specifies a tensor to
vector operation there will be 3 offsets.
Vector or tensor results will be transformed to the alternate coordinate frame identifier if specified.
The input value derivation can have the following values:
Chapter 6: Results Postprocessing Functions 1423
Results Utility Functions
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
This function can display an information popup message form with the following messages:
16000001Error code %I% occurred in %A%.
16000002Called from %A%.
30001425Notice: %I% interpolants lie off the field.
30001437An attempt was made to average nodal values for an element. All of the element nodes were
not found for %I% elements.
This function can display a warning popup message form with the following messages:
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
38000199WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing
surface) of %7.5f. The design build gap is %7.5f. Automatic gap fill invoked!
OR
WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing surface)
of %7.5f. The design build gap is %7.5f. Delete and Rebuild the Composite Trim Surface!
OR
1424 PCL Reference Manual
Results Utility Functions
ERROR -- Composite Trim Surface Evaluator cannot compute a point on surface! The problem is a
vertical surface. Check the geometry, change view orientation, Delete and Rebuild the Composite Trim
Surface!
30001424Routine to locate points in elements did not converge for %I% interpolants.
This function can display a fatal popup message form with the following messages:
13000088Preference not found.
16000201Database error for item %I%: %A%.
30001061Field %A% is disassociated with geometry entity and unusable unless a new geometry entity
is provided.
38000136CompTrimSurface processor cannot locate surface with LABEL=%I% -- This is a database
FAILURE! -- Delete and Rebuild the CompTrim Surface.
Example:
Description:
This function extracts the specified results data from the database.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier.
STRING elem_list[] This value specifies a list of elements for which to
extract results.
STRING derivation[10] This value specifies the derivation specifier if the
results are to be derived. A value of null will leave the
result as is. See the remarks below for more
information.
STRING location[] This value specifies the location of the coordinate
frame identifier: "", "A" = axis, "C" = centroid, and
"N" = nodal.
STRING cid[] This value specifies the coordinate system for vector
and tensor transformations. A null string is used to
leave the coordinate frame identifier as is.
STRING avg_method[] This value specifies the averaging method to be used.
STRING avg_domain[] This value specifies the averaging domain to be used.
STRING extrap_method[] This value specifies the method to use in
extrapolation.
STRING complex_form[] This value specifies the form to be used for complex
numbers.
REAL complex_angle This value is used with complex results when the
complex_form is Angle.
Output:
INTEGER data_type This value returns the data type. Valid values are:
1=scalar, 2=vector, and 3=tensor.
INTEGER resloc This value returns the result location. Valid values
are: 1=centroid, 2=nodal, 3=multiple, and 4=mixed.
INTEGER nres This value returns the number of returned element
identifiers.
1426 PCL Reference Manual
Results Utility Functions
Error Conditions:
1 This is an internal status condition. There is no corresponding status
message in the message database.
4500003 A memory allocation error has occurred. Please check function inputs and
call RES_UTL_FREE_RESULTS() before proceeding.
4500005 No Elements are found for the specified result matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination
specified cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500008 The input Location string is invalid.
4500009 No results are found in the database matching the specified Ids.
4500010 The derivation specified in invalid.
4500011 A error has occurred extrapolating this result to the element nodes.
4500014 An error has occurred interpreting the input List string.
4500015 The specified Coordinate Frame does not exist.
4500018 The Coordinate Frame List is not valid.
13000054 Result case not found.
13000056 Coordinate frame not found.
13000071 Result case type not found.
13000085 Cursor not open.
13000086 No Records Found.
13000117 The query specified has completed.
13000210 The system is out of virtual memory.
Chapter 6: Results Postprocessing Functions 1427
Results Utility Functions
Remarks:
This function will perform extrapolation and averaging as necessary when element based results are
requested.
The result data type returned will be determined by the input value derivation.
Results may be extracted either at element centroids, element nodes or as found.
The value in the output values minloc or maxloc are not the direct index into the output value results. Use
the following formula to obtain the index into the output value results using the values in the output
values minloc or maxloc: res_index = loc(2,i) + nresults(1) + nresults(2) + ... + nresults(loc(1,i)-1). If the
element results are centroidal this will become: res_index = loc(1,i).
The specified result will be held in memory for further operations. Only one result is held in memory at
a time.
The output value ids will be allocated with the number of offsets defined by the output value nres.
The output value results will be allocated as a two dimensional array where the number of offsets in the
first dimension of the array will be set by the sum of all of the values in the output value nresults. The
number of offsets in the second dimension is dependent on the input value derivation. The second
dimension of the output value results will be set as follows: If the input value derivation specifies a
tensor to scalar or vector to scalar operation there will be 1 offset. If the input value derivation
specifies a tensor to vector operation there will be 3 offsets.
The output values minloc and maxloc will be allocated as two dimensional arrays where the number of
offsets in the first dimension of the array will be set by the output value nres. The number of offsets in
the second dimension is dependent on the input value derivation. The second dimension of the output
values minloc and maxloc will be set as follows: If the input value derivation specifies a tensor to scalar
or vector to scalar operation there will be 1 offset. If the input value derivation specifies a tensor to
vector operation there will be 3 offsets.
Vector or tensor results will be transformed to the alternate coordinate frame identifier if specified.
The input value derivation can have the following values:
1428 PCL Reference Manual
Results Utility Functions
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
38000199WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing
surface) of %7.5f. The design build gap is %7.5f. Automatic gap fill invoked!
OR
WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing surface)
of %7.5f. The design build gap is %7.5f. Delete and Rebuild the Composite Trim Surface!
OR
ERROR -- Composite Trim Surface Evaluator cannot compute a point on surface! The problem is a
vertical surface. Check the geometry, change view orientation, Delete and Rebuild the Composite Trim
Surface!
30001424Routine to locate points in elements did not converge for %I% interpolants.
This function can display a fatal popup message form with the following messages:
13000088Preference not found.
16000201Database error for item %I%: %A%.
30001061Field %A% is disassociated with geometry entity and unusable unless a new geometry entity
is provided.
38000136CompTrimSurface processor cannot locate surface with LABEL=%I% -- This is a database
FAILURE! -- Delete and Rebuild the CompTrim Surface.
Example:
INTEGER i, j, idx, nres, dtype, resloc, minloc(2,6), maxloc(2,6), status
INTEGER eids(VIRTUAL), nresults(VIRTUAL)
REAL results(VIRTUAL)
/* Extract the element tensor result with Loadcase ID=2, Subcase ID=1,Primary Res
ID=3, Secondary Res ID=1, Layer ID=1 at the element nodes and orient the tensor
with the global*/
status = res_utl_extract_elem_results( [2,1,3,1,1], "Elm 1:#", @
"", "n", "Coord 0", dtype, resloc, nres, eids, nresults, @
results, minloc, maxloc )
IF( status != 0 ) THEN @ /* print message if error */
msg_to_form( status, 4, 0, 0, 0., "" )
ELSE
/* print out min/max for each stress component */
FOR( j = 1 TO 6 )
idx = minloc(2,j)
FOR( i = 1 TO minloc(1,j)-1)
idx += nresults(i)
END FOR
ui_writec(" Min Id= %d, Comp= %d, Stress= %g", @
ids(minloc(1,i)), j, results(idx,j) )
idx = maxloc(2,j)
FOR( i = 1 TO maxloc(1,j)-1)
idx += nresults(i)
END FOR
1430 PCL Reference Manual
Results Utility Functions
Description:
This function extracts the specified results data from the database.
Input:
INTEGER nlcs This value specifies the number of result cases to be
extracted.
INTEGER lcids(nlcs) This value specifies the load case identifiers.
INTEGER subids(nlcs) This value specifies the subcase identifiers.
INTEGER result_ids(3) This value specifies the primary result identifier, secondary
result identifier, and layer identifier.
STRING elem_list[] This value specifies a list of elements at which to extract
results.
STRING derivation[10] This value specifies the derivation specifier if the results
are to be derived. A value of null will leave the result as is.
See the remarks below for more information.
STRING location[] This value specifies the coordinate frame identifier
location: "", "A" = axis, "C" = centroid, and "N" = nodal.
STRING cid[] This value specifies the coordinate system for
vector/tensor transformations. A null string is used to leave
the coordinate frame identifier as is.
Output:
INTEGER data_type This value returns the data type. Valid values are: 1=scalar,
2=vector, and 3=tensor.
INTEGER resloc This value returns the results location. Valid values are:
1=centroid, 2=nodal, and 3=multiple.
INTEGER nres This value returns the number of node identifiers.
INTEGER ids(VIRTUAL) This value returns a list of node identifiers.
INTEGER nresults(VIRTUAL) This value returns the number of results per element.
REAL results(VIRTUAL) This value returns all of the results at the specified node for
each result case.
INTEGER minloc(VIRTUAL) This value returns the array offsets for each minimum
result component in the output value results.
1432 PCL Reference Manual
Results Utility Functions
INTEGER maxloc(VIRTUAL) This value returns the array offsets for each maximum
result component in the output value results.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500005 No Elements are found for the specified result matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination specified
cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500008 The input Location string is invalid.
4500009 No results are found in the database matching the specified Ids.
4500010 The derivation specified in invalid.
4500011 A error has occurred extrapolating this result to the element nodes.
4500014 An error has occurred interpreting the input List string.
4500015 The specified Coordinate Frame does not exist.
4500018 The Coordinate Frame List is not valid.
13000054 Result case not found.
13000056 Coordinate frame not found.
13000071 Result case type not found.
13000085 Cursor not open.
13000086 No Records Found.
13000117 The query specified has completed.
13000210 The system is out of virtual memory.
14000281 LpExpandPclVariables: Virtual memory is full.
14000298 LpPicklistDecoder: Parse error.
14000299 LpPicklistDecoder: Memory is exhausted.
14000302 LpPicklistDecoderWithLookup: Memory is exhausted.
Remarks:
The result data type returned will be determined by the input value derivation.
The minimum and maximum subcase locations will be determined for each element location specified.
The values in the output values minloc or maxloc are not the direct index into the output value results.
Use the following formula to obtain the index into the output value results using the values in the output
values minloc or maxloc: res_index = loc(2,i) + nresults(1) + nresults(2) + ... + nresults(loc(1,i)-1). If the
element results are centroidal this will become: res_index = loc(1,i).
The last specified result will be held in memory for further operations. Only one result is held in memory
at a time.
The output value ids will be allocated with the number of offsets defined by the output value nres.
The output value results will be allocated as a two dimensional array where the number of offsets in the
first dimension of the array will be set by the sum of all of the values in the output value nresults. The
number of offsets in the second dimension is dependent on the input value derivation. The second
dimension of the output value results will be set as follows: If the input value derivation specifies a
tensor to scalar or vector to scalar operation there will be 1 offset. If the input value derivation
specifies a tensor to vector operation there will be 3 offsets.
The output values minloc and maxloc will be allocated as two dimensional arrays where the number of
offsets in the first dimension of the array will be set by the output value nres. The number of offsets in
the second dimension is dependent on the input value derivation. The second dimension of the output
values minloc and maxloc will be set as follows: If the input value derivation specifies a tensor to scalar
or vector to scalar operation there will be 1 offset. If the input value derivation specifies a tensor to
vector operation there will be 3 offsets.
Vector or tensor results will be transformed to the alternate coordinate frame identifier if specified.
The input value derivation can have the following values:
1434 PCL Reference Manual
Results Utility Functions
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
This function can display an information popup message form with the following messages:
16000001Error code %I% occurred in %A%.
16000002Called from %A%.
30001425Notice: %I% interpolants lie off the field.
30001437An attempt was made to average nodal values for an element. All of the element nodes were
not found for %I% elements.
This function can display a warning popup message form with the following messages:
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
38000199WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing
surface) of %7.5f. The design build gap is %7.5f. Automatic gap fill invoked!
OR
WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing surface)
of %7.5f. The design build gap is %7.5f. Delete and Rebuild the Composite Trim Surface!
OR
ERROR -- Composite Trim Surface Evaluator cannot compute a point on surface! The problem is a
vertical surface. Check the geometry, change view orientation, Delete and Rebuild the Composite Trim
Surface!
30001424Routine to locate points in elements did not converge for %I% interpolants.
Chapter 6: Results Postprocessing Functions 1435
Results Utility Functions
This function can display a fatal popup message form with the following messages:
30001061Field %A% is disassociated with geometry entity and unusable unless a new geometry entity
is provided.
Example:
Description:
This function extracts the specified results data from the database.
Input:
INTEGER nlcs This value specifies the number of result cases to be
extracted.
INTEGER lcids(nlcs) This value specifies the load case identifiers.
INTEGER subids(nlcs) This value specifies the subcase identifiers.
INTEGER result_ids(3) This value specifies the primary result identifier, secondary
result identifier, and layer identifier.
STRING elem_list[] This value specifies a list of elements at which to extract
results.
STRING derivation[10] This value specifies the derivation specifier if the results are
to be derived. A value of null will leave the result as is. See
the remarks below for more information.
STRING location[] This value specifies the coordinate frame identifier
location: "", "A" = axis, "C" = centroid, and "N" = nodal.
STRING cid[] This value specifies the coordinate system for vector/tensor
transformations. A null string is used to leave the
coordinate frame identifier as is.
STRING avg_method[] This value specifies the averaging method to use.
STRING avg_domain[] This value specifies the averaging domain to use.
STRING extrap_method[] This value specifies the extrapolation method to use.
STRING complex_form[] This value specifies the form to be used with complex
numbers.
REAL complex_angle This value is used with complex results when the
complex_form is Angle.
Output:
INTEGER data_type This value returns the data type. Valid values are: 1=scalar,
2=vector, and 3=tensor.
INTEGER resloc This value returns the results location. Valid values are:
1=centroid, 2=nodal, and 3=multiple.
Chapter 6: Results Postprocessing Functions 1437
Results Utility Functions
Remarks:
The result data type returned will be determined by the input value derivation.
The minimum and maximum subcase locations will be determined for each element location specified.
The values in the output values minloc or maxloc are not the direct index into the output value results.
Use the following formula to obtain the index into the output value results using the values in the output
values minloc or maxloc: res_index = loc(2,i) + nresults(1) + nresults(2) + ... + nresults(loc(1,i)-1). If the
element results are centroidal this will become: res_index = loc(1,i).
The last specified result will be held in memory for further operations. Only one result is held in memory
at a time.
The output value ids will be allocated with the number of offsets defined by the output value nres.
The output value results will be allocated as a two dimensional array where the number of offsets in the
first dimension of the array will be set by the sum of all of the values in the output value nresults. The
number of offsets in the second dimension is dependent on the input value derivation. The second
dimension of the output value results will be set as follows: If the input value derivation specifies a
tensor to scalar or vector to scalar operation there will be 1 offset. If the input value derivation
specifies a tensor to vector operation there will be 3 offsets.
The output values minloc and maxloc will be allocated as two dimensional arrays where the number of
offsets in the first dimension of the array will be set by the output value nres. The number of offsets in
the second dimension is dependent on the input value derivation. The second dimension of the output
values minloc and maxloc will be set as follows: If the input value derivation specifies a tensor to scalar
or vector to scalar operation there will be 1 offset. If the input value derivation specifies a tensor to
vector operation there will be 3 offsets.
Vector or tensor results will be transformed to the alternate coordinate frame identifier if specified.
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
38000199WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing
surface) of %7.5f. The design build gap is %7.5f. Automatic gap fill invoked!
OR
WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing surface)
of %7.5f. The design build gap is %7.5f. Delete and Rebuild the Composite Trim Surface!
OR
ERROR -- Composite Trim Surface Evaluator cannot compute a point on surface! The problem is a
vertical surface. Check the geometry, change view orientation, Delete and Rebuild the Composite Trim
Surface!
30001424Routine to locate points in elements did not converge for %I% interpolants.
This function can display a fatal popup message form with the following messages:
13000088Preference not found.
16000201Database error for item %I%: %A%.
30001061Field %A% is disassociated with geometry entity and unusable unless a new geometry entity
is provided.
38000136CompTrimSurface processor cannot locate surface with LABEL=%I% -- This is a database
FAILURE! -- Delete and Rebuild the CompTrim Surface.
Example:
INTEGER i, nres, dtype, resloc, minloc(VIRTUAL), @
maxloc(VIRTUAL), status
INTEGER eids(VIRTUAL), nresults(VIRTUAL), lcids(5)=2,5,9,11,15
REAL results(VIRTUAL)
Description:
This function adds the specified results data to the database.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier. The primary and result
identifiers are not used as inputs by this function. This
value is used as both an input and an output to the
function and would be passed by the calling function as
a single argument.
STRING primary_title[80] This value specifies the primary result title.
STRING secondary_title[80] This value specifies the secondary result title.
INTEGER nids This value specifies the number of input element
identifiers.
INTEGER ids() This value specifies the element identifiers for the
results.
STRING cid_list[] This value specifies the alternate coordinate system for
vector or tensor results. A null string is used for the
global coordinate system.
INTEGER data_type This value specifies the data type to use: 1=scalar,
2=vector, and 3=tensor.
STRING location[] This value specifies the location to use: "C" = centroid,
and "N" = nodal.
INTEGER nresults() This value specifies the number of results per element.
REAL results() This value specifies an array of all of the results at the
specified nodes.
Output:
INTEGER result_ids(5) This value returns the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier. The load case, subcase,
and layer identifiers are not used as output values by
this function. The primary and result identifiers are used
as outputs by this function. This value is used as both an
input and an output to the function and would be passed
by the calling function as a single argument.
1442 PCL Reference Manual
Results Utility Functions
Remarks:
This function expects that a load case or subcase and a layer position already exist.
The value result_ids will be used as both an input and an output value.
The primary and secondary identifiers returned by the input and output value result_ids are based on the
input values primary_title and secondary_title. These input values primary_title and secondary_title will
either match up with existing primary and secondary results or new ones will be generated.
Example:
Description:
This function extracts the specified results data from the database and interpolate as needed to obtain
results along a specified set of XYZ coordinates defining the path.
Input:
INTEGER result_ids(5) This value specifies the load case identifier, subcase
identifier, primary result identifier, secondary result
identifier, and layer identifier.
INTEGER npts This value specifies the number of path points.
REAL pts(npts*3) This value specifies global XYZ point locations.
STRING derivation[10] This value specifies the derivation specifier if the results
are to be derived. A value of null will leave the result as
is. See the remarks below for more information.
STRING cid[] This value specifies the coordinate system for
vector/tensor transformations. A null string is used to
leave the coordinate frame identifier as is.
Output:
INTEGER data_type This value returns the data type. Valid values are:
1=scalar, 2=vector, and 3=tensor.
REAL results(VIRTUAL) This value returns all of the results at the specified path
points.
INTEGER minloc(6) This value returns the point index for each minimum
result component.
INTEGER maxloc(6) This value returns the point index for each maximum
result component.
INTEGER elem_ids(npts) This value returns identifiers for elements containing each
point. No identifiers or 0 will be returned if a point was
not interpolated.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
1 This is an internal status condition. There is no corresponding status message in the
message database.
4500002 An error has occurred calculating a nodal averaged result.
1444 PCL Reference Manual
Results Utility Functions
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500004 No Nodes found in the database matching the input list.
4500005 No Elements found in the database matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination
specified cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500009 No results are found in the database matching the specified Ids.
4500010 The derivation specified in invalid.
4500011 A error has occurred extrapolating this result to the element nodes.
4500015 The specified Coordinate Frame does not exist.
4500018 The Coordinate Frame List is not valid.
4500020 The input path specified points which did not interpolate to any elements.
13000054 Result case not found.
13000056 Coordinate frame not found.
13000071 Result case type not found.
13000086 No Records Found.
13000210 The system is out of virtual memory.
Remarks:
The result data type returned will be determined by the derivation method.
If an element result is specified, it will be extrapolated to the nodes and nodal averaged result values will
be computed and used for path interpolation.
This function supports TRI3, TRI6, QUAD4, QUAD8, TET4, TET10, WEDGE6, WEDGE15, HEX8,
and HEX20 element types for interpolation. Other element shapes may yield undesirable results.
The specified result will be held in memory for further operations. Only one result is held in memory at
a time.
The output value results will be allocated as a two dimensional array where the number of offsets in the
first dimension of the array will be returned by the output value npts. The number of offsets in the second
dimension is dependent on the input value derivation. The second dimension of the output value results
will be set as follows: If the input value derivation specifies a tensor to scalar or vector to scalar
operation there will be 1 offset. If the input value derivation specifies a tensor to vector operation there
will be 3 offsets.
Vector or tensor results will be transformed to the alternate coordinate frame identifier if specified.
Chapter 6: Results Postprocessing Functions 1445
Results Utility Functions
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
This function can display an information popup message form with the following messages:
30001437An attempt was made to average nodal values for an element. All of the element nodes were
not found for %I% elements.
This function can display a warning popup message form with the following messages:
4500019The results specified for this operation are defined in an Unknown element local coordinate
system. The global system will be assumed for all transformation operations. Errors may be introduced
when using nodal averaged or transformed result components.
38000199WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing
surface) of %7.5f. The design build gap is %7.5f. Automatic gap fill invoked!
OR
WARNING -- The Composite Trim Surface Evaluator has detected a large gap (or missing surface) of
%7.5f. The design build gap is %7.5f. Delete and Rebuild the Composite Trim Surface!
OR
1446 PCL Reference Manual
Results Utility Functions
ERROR -- Composite Trim Surface Evaluator cannot compute a point on surface! The problem is a
vertical surface. Check the geometry, change view orientation, Delete and Rebuild the Composite Trim
Surface!
30001424Routine to locate points in elements did not converge for %I% interpolants.
This function can display a fatal popup message form with the following messages:
30001061Field %A% is disassociated with geometry entity and unusable unless a new geometry entity
is provided.
Example:
Description:
This function retrieves the existing load cases with associated results from the database.
Input:
None.
Output:
INTEGER ncases This value returns the number of load cases found.
INTEGER lcids(VIRTUAL) This value returns a list of load case identifiers.
INTEGER nsub(VIRTUAL) This value returns the number of subcases for each load
case.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
13000052 Load case not found.
Remarks:
Chapter 6: Results Postprocessing Functions 1447
Results Utility Functions
The output values lcids and nsub will be allocated by the function.
Example:
Description:
This function retrieves the existing subcases with associated results from the database.
Input:
INTEGER lcid This value specifies the loadcase identifier.
Output:
INTEGER nsub This value returns the number of subcases found.
INTEGER subids(VIRTUAL) This value returns a list of subcase identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
13000052 Load case not found.
13000053 Sub case not found.
Remarks:
Description:
This function retrieves the existing results identifiers associated with a list of load case and subcase
identifiers from the database.
Input:
INTEGER nlcs This value specifies the number of load cases.
INTEGER lcid(nlcs) This value specifies load case identifiers.
INTEGER subids() This value specifies subcase identifiers.
Output:
INTEGER nres This value returns the number of results found.
INTEGER primary_id(VIRTUA This value returns a list of primary result identifiers.
L)
INTEGER secondary_id(VIRTUAL)
This value returns a list of secondary result identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500009 No results are found in the database matching the specified Ids.
Remarks:
The output values primary_id and secondary_id will be allocated by the function.
Example:
Description:
This function retrieves the layer positions associated with results from the database.
Input:
INTEGER result_ids(4) This value specifies the load case identifier, subcase
identifier, primary result identifier, and secondary result
identifier.
Output:
INTEGER nlayers This value returns the number of associated layers found.
INTEGER ids(VIRTUAL) This value returns a list of layer position identifiers.
STRING labels[80](VIRTUAL This value returns the labels for the layers found.
)
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
13000054 Result case not found.
13000071 Result case type not found.
13000093 Too Many Values Returned for Space Allocated.
13000210 The system is out of virtual memory.
Remarks:
ALL results have at least one associated layer position identifier. Non-layered result layer titles may be
blank.
The output values ids and labels will be allocated by the function.
Example:
Description:
This function retrieves the existing global variables from the database.
Input:
None.
Output:
INTEGER nvar This value returns the number of global variables found.
STRING var_name[80](VIRTUAL)
This value returns the labels for the variables found.
INTEGER <Return This function returns a value of 0 when executed
Value> successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
4500003 A memory allocation error has occurred. Please check function inputs and
call RES_UTL_FREE_RESULTS() before proceeding.
Remarks:
Description:
This function retrieves the value of a specific global variable associated with a load case and subcase.
Input:
INTEGER lcid This value specifies the load case identifier.
INTEGER subid This value specifies the subcase identifier.
STRING var_name[] This value specifies the global variable name.
Output:
INTEGER ncomp This value returns the number of components used for the
variable value 1, 3 or 6.
REAL vals(6) This value returns the value[s] for the global variable.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
4500012 The specified global variable is not found.
13000054 Result case not found.
13000055 Global variable not found.
Remarks:
None.
Example:
Description:
This function retrieves all subcase identifiers with the specified global variable value within the
specified range.
Input:
INTEGER lcid This value specifies the loadcase identifier.
STRING var_name[] This value specifies the global variable name.
INTEGER compnum This value specifies the component of the values to use.
This value is usually set to 1.
REAL val1 This value specifies the lower value of the range.
REAL val2 This value specifies the upper value of the range.
STRING method[] This value specifies the method used to retrieve the
subcase identifiers. Valid values are: "U" = under, "B" =
between, "A" = above, and "O" = outside.
Output:
INTEGER nscs This value returns the number of subcases found.
INTEGER subids(VIRTUAL) This value returns a list of subcase identifiers.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500009 No results are found in the database matching the specified Ids.
4500013 The filter method specified is not valid.
13000052 Load case not found.
13000053 Sub case not found.
Remarks:
Since a floating-point compare is performed to filter subcases, a tolerance should be added the range
values to assure an expected behavior.
The input value method is case insensitive and only the first character is used.
Chapter 6: Results Postprocessing Functions 1453
Results Utility Functions
Example:
Description:
This function operates mathematically on two result values on a component by component basis.
Input:
REAL res1() This value specifies the first result value or constant.
STRING operator[] This value specifies the operator to use. A + will
add the input values res1+res2.
REAL res2() This value specifies the second result value or
constant.
Output:
REAL res3() This value returns the result value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
4500001 One of the input array arguments is of an insufficient dimension.
4500017 The specified operation is not valid.
Remarks:
The value in either the input value res1 or res2 may be used as a constant. This is accomplished by using
a single dimensional array as one of the input values res1 or res2.
The size of the input values res1, res2, and the output value res3 is determined by the declaration. All
elements of the input values will be operated on.
The input value operation can have the following values:
1454 PCL Reference Manual
Results Utility Functions
Example:
Description:
This function calculates the dot product of 2 vector result values.
Input:
INTEGER nres This value specifies the number of result vectors in the
values.
REAL res1(nres,3) This value specifies the first vector result value.
REAL res2(nres,3) This value specifies the second vector result value.
Output:
REAL res3(nres) This value returns the scalar results value of dot
products.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully.
Error Conditions:
None.
Remarks:
None.
Example:
Description:
This function calculates the cross product of two vector result values.
Input:
INTEGER nres This value specifies the number of result vectors in
values.
REAL res1(nres,3) This value specifies the first vector result value.
REAL res2(nres,3) This value specifies the second vector result value.
Output:
REAL res3(nres,3) This value returns the vector results value of cross
products.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully.
Error Conditions:
None.
Remarks:
None.
Example:
Please see res_utl_cross_results (p. 1020) in the PCL Reference Manual Examples.
Chapter 6: Results Postprocessing Functions 1457
Results Utility Functions
Description:
This function transforms the input vector or tensor values from one rectangular coordinate system to
another.
Input:
INTEGER nvals This value specifies the number of result vectors in
the result values.
INTEGER ncomp This value specifies the number of components as 3 or
6
REAL in_vals(nvals,ncom This value specifies the result value.
p)
INTEGER from_cid This value specifies the FROM coordinate frame
identifier.
INTEGER to_cid This value specifies the TO coordinate frame
identifier.
Output:
REAL out_vals(nvals,ncomp) This value returns the transformed result value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
4500001 One of the input array arguments is of an insufficient dimension.
4500015 The specified Coordinate Frame does not exist.
4500017 The specified operation is not valid.
4500018 The Coordinate Frame List is not valid.
Remarks:
This function only supports transformations between rectangular coordinate systems. If cylindrical or
spherical transformations are needed, the create or extract functions need to be used so that geometric
node and element locations can be determined.
Example:
The register functions will generally operate in the following fashion: A call, or a series of calls to the
functions used to define registers will be generated by events in the user interface. The register definitions
will be stored in the database and in a corresponding register. The DrDataDescriptor object that
contains the definition of the register will be constructed. After the registers are created, calls made to the
results display manager functions will display a plot of results data, generate data for an XY plot, or
output tabular results. The display manager will determine the finite element model entity domain for the
display request and query the specified register for data. If the register does not already hold data for the
required domain, it will be generated and held in the DrDataObject object. As the entities in the
display domain are traversed, the DrDataObject object will provide data as needed for each entity. If
at a later time it is determined that the data is no longer needed, the DrDataObject object will be
removed.
1460 PCL Reference Manual
Data Register Definition Functions
Description:
This function specifies a result to be extracted from the database and manipulated into a format for
subsequent display. This description will be stored in the specified register.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and "EL"
= element.
STRING result_type[] This value specifies the results data type. Valid values
are: "S" = scalar, "V" = vector, and "T" = tensor.
STRING load_case[] This value specifies the load case identifier.
STRING subcase[] This value specifies the subcase identifier.
STRING primary_result[] This value specifies the identifier of the primary result.
STRING secondary_result[] This value specifies the identifier of the secondary result.
STRING layer[] This value specifies the layer position identifier.
STRING derivation[10] This value specifies the derivation specifier if the results
are to be derived. A null will leave the result as is. See the
remarks below for more information.
STRING coordinate[] This value specifies the coordinate for transformations.
Valid values are: = as is, Coord i = Db coordinate
system, "M" = material system, "IJK" = element ijk
system, "N" = nodal system, and "G" = global.
STRING averaging_method[] This value specifies the averaging method: derive-avg
to perform derivations and transformations, then average
the results, avg-derive (transform to global, average,
then derive/transform), difference (calculate the
difference versus average, derivations performed first),
and sum (sum all of the element nodal components at
the nodes).
Chapter 6: Results Postprocessing Functions 1461
Data Register Definition Functions
Remarks:
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
Example:
None.
Chapter 6: Results Postprocessing Functions 1463
Data Register Definition Functions
Description:
Create an enodal scalar register to hold the specified element scalar data
Input:
INTEGER reg This value specifies the register identifier.
INTEGER scalar_id The scalar_id is a unique identifier that you supply to this
call. It internally establishes a scalar container that you
can load with data and then post process.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
1464 PCL Reference Manual
Data Register Definition Functions
Description:
This function specifies a title string to be associated with the register. If this title is not specified, a
default title based on the source of the data will be used.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and "EL" =
element.
STRING register_type[] This value specifies the register type. Valid values are:
"S" = scalar, "V" = vector, and "T" = tensor.
INTEGER count This value specifies the number of title lines.
STRING titles[](count) This value specifies the title lines to be associated with
the data in the register.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
None.
Chapter 6: Results Postprocessing Functions 1465
Data Register Definition Functions
Description:
This function gets the number of title lines stored in a register.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the results
data is associated. Valid values are: "C" = centroid, "N" =
nodal, "EN" = element nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid values are: "S" =
scalar, "V" = vector, and "T" = tensor.
Output:
INTEGER count This value returns the number of title lines associated to this
register.
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function returns the number of titles and the titles themselves stored in a register.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" = centroid,
"N" = nodal, "EN" = element nodal, and "EL" = element.
STRING register_type This value specifies the register type. Valid values are: "S"
[] = scalar, "V" = vector, and "T" = tensor.
Output:
INTEGER count This value returns the number of title lines associated with
this register.
STRING titles[](count This value returns the title lines associated with this
) register.
INTEGER <Return This function returns a value of 0 when executed
Value> successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function specifies a series of database result specifiers to be associated with a specific register.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which
the results data is associated. Valid values are:
"C" = centroid, "N" = nodal, "EN" = element
nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid
values are: "S" = scalar, "V" = vector, and "T" =
tensor.
INTEGER count This value specifies a count of the number of
results.
STRING load_cases[](count) This value specifies an value of load case
identifiers.
STRING subcases[](count) This value specifies an value of subcase
identifiers.
STRING primary_result[](count This value specifies an value of primary results
) identifiers.
STRING secondary_result[](co This value specifies an value of secondary
unt) results identifiers.
STRING layers[](count) This value specifies an value of layer position
identifiers.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This register must have previously be loaded with the res_data_load_dbresult() function and all of the
results must be of the same type.
The list of results can be subsequently used for animation, interpolation, summation, and minimum or
maximum value extraction.
1468 PCL Reference Manual
Data Register Definition Functions
Example:
Please see res_data_dbres_list (p. 1031) in the PCL Reference Manual Examples.
Description:
This function specifies a series of registers to be associated with a specific register.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and "EL"
= element.
STRING register_type[] This value specifies the register type. Valid values are:
"S" = scalar, "V" = vector, and "T" = tensor.
INTEGER count This value specifies the number of registers.
INTEGER register_list(count) This value specifies an value of register identifiers.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The list of registers can be subsequently used for animation, interpolation, summation, and minimum or
maximum value extraction.
Example:
Description:
This function specifies that the data specified by a register list should be summed.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and
"EL" = element.
STRING register_type[] This value specifies the register type. Valid values
are: "S" = scalar, "V" = vector, and "T" = tensor.
INTEGER count This values specifies the first count result cases.
REAL weights(count) This value specifies the optional weighting values for
the summation. Optional=NULL.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The register list must have been previously defined using the res_data_dbres_list() or
res_data_register_list() functions.
Example:
Description:
This function specifies that the data specified by a register list should be scanned for the maximum
values.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the results data
is associated. Valid values are: "C" = centroid, "N" = nodal, "EN"
= element nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid values are: "S" =
scalar, "V" = vector, and "T" = tensor.
STRING method[] This value specifies the averaging method: derive-avg
(perform derivations/transformations, then average), avg-
derive (transform to global, average, then derive/transform),
difference (calculate the difference versus average, derivations
performed first), and sum (sum all of the element nodal
components at the nodes).
STRING derivation[10] This value specifies the derivation specifier if the results are to
be derived. A null will leave the result as is. See the remarks
below for more information.
Output:
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The register list must have been previously defined using the res_data_dbres_list() or
res_data_register_list() functions.
The register will maintain both the result and source for each FEM entity.
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
Example:
Description:
This function specifies that the data specified by a register list should be scanned for the minimum
values.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the results
data is associated. Valid values are: "C" = centroid, "N" =
nodal, "EN" = element nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid values are: "S" =
scalar, "V" = vector, and "T" = tensor.
STRING method[] This value specifies the averaging method: derive-avg
(perform derivations/transformations, then average), avg-
derive (transform to global, average, then derive/transform),
difference (calculate the difference versus average,
derivations performed first), and sum (sum all of the element
nodal components at the nodes).
STRING derivation[10] This value specifies the derivation specifier if the results are to
be derived. A null will leave the result as is. See the remarks
below for more information.
Output:
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The register list must have been previously defined using the res_data_dbres_list() or
res_data_register_list() functions.
The register will maintain both the result and source for each FEM entity.
The input value derivation can have the following values:
Chapter 6: Results Postprocessing Functions 1473
Data Register Definition Functions
Vector to Scalar: XX YY ZZ
MAG MAXCMP MINCMP
AVG
Example:
Description:
This function specifies the method for interpolating/extrapolating data values between values in the
specified register list.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the results
data is associated. Valid values are: "C" = centroid, "N" =
nodal, "EN" = element nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid values are: "S" =
scalar, "V" = vector, and "T" = tensor.
STRING global_name[] This value specifies the name of the global variable.
REAL value This value specifies the value of the global variable.
STRING interpolation[] This value specifies the interpolation method: Linear to
perform linear interpolation between the two closest data
sets, Cubic to perform a cubic spline fit across the closest
four data sets, Closest to use the data set with the global
variable closest to the specified value, Ceiling to use the
data set with the next higher global variable value, and
Floor to use the data set with the next lower global variable
value.
STRING extrapolation[] This value specifies the extrapolation method: Error to do
nothing, Constant to use the closest data set, and Linear
to extrapolate out at the ending slope.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The register list must have been previously defined using the res_data_dbres_list() or
res_data_register_list() functions.
Only the data which is associated to the specified global variable will be considered during this operation.
Chapter 6: Results Postprocessing Functions 1475
Data Register Definition Functions
The extrapolation specifier controls what action is taken when the global variable value is outside of the
range spanned by the list.
Example:
Description:
This function specifies the method for interpolating data values between values in the specified
register list.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the results
data is associated. Valid values are: "C" = centroid, "N" =
nodal, "EN" = element nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid values are: "S"
= scalar, "V" = vector, and "T" = tensor.
REAL factor A factor from 0.0 to 1.0.
STRING interpolation[] This value specifies the interpolation method: Linear to
perform linear interpolation between the two closest data
sets, Cubic to perform a cubic spline fit across the closest
four data sets, Closest to use the data set with the global
variable closest to the specified value, Ceiling to use the
data set with the next higher global variable value, and
Floor to use the data set with the next lower global
variable value.
STRING extrapolation[] This value specifies the extrapolation method: Error to do
nothing, Constant to use the closest data set, and Linear
to extrapolate out at the ending slope.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
1476 PCL Reference Manual
Data Register Definition Functions
Remarks:
The register list must have been previously defined using the res_data_dbres_list() or
res_data_register_list() function. This function simply performs a linear interpolation of a list.
The factor may be varied from 0.0 to 1.0. Each data set in the list will be treated as evenly spaced
data sets with the first set having a factor of 0.0 and the last having a factor of 1.0.
This type of interpolation is useful for data not having associated global variables
Example:
Description:
This function sums the data specified by a register list.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the results data
is associated. Valid values are: "C" = centroid, "N" = nodal, "EN"
= element nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid values are: "S" =
scalar, "V" = vector, and "T" = tensor.
Output:
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The register list must have been previously defined using the res_data_dbres_list() or
res_data_register_list() functions.
Example:
None.
Chapter 6: Results Postprocessing Functions 1477
Data Register Definition Functions
Description:
This function specifies a format function used to determine the data values of a register.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and "EL" =
element.
STRING register_type[] This value specifies the register type. Valid values are:
"S" = scalar, "V" = vector, and "T" = tensor.
STRING function[] This value specifies a PCL function such as ($1 + $2 /
$4) * $5. The $n specifiers are register identifiers.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The registers specified in the function must be of the same location and type and must have been
previously loaded with a res_data_load() function.
Example:
Description:
This function specifies three scalar registers whose data are to make up the components of a vector data
set.
Input:
INTEGER vector_register This value specifies the register identifier that will hold
the vector data.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and "EL"
= element.
STRING coordinate[] This value specifies the coordinate system for the
orientation definition of the vector. Valid values are: =
global, Coord i = Db coordinate system, "M" =
material system, "IJK" = element ijk system, "N" = nodal
system, and "G" = global.
INTEGER scalar_regsisters(3) This value specifies the identifiers for the three registers
holding the scalar data for each component of the vector
data.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
Description:
This function specifies six scalar registers whose data are to make up the components of a tensor data
set.
Input:
INTEGER tensor_register This value specifies the register identifier that will hold
the tensor data.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and "EL"
= element.
STRING coordinate[] This value specifies the coordinate system for the
orientation definition of the tensor. Valid values are:
= global, Coord i = Db coordinate system, "M" =
material system, "IJK" = element ijk system, "N" =
nodal system, and "G" = global.
INTEGER scalar_regsisters(6) This value specifies the identifiers for the six registers
holding the scalar data for each component of the tensor
data.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
Description:
This function specifies the method for determining the output format of complex data.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and
"EL" = element.
STRING register_type[] This value specifies the register type. Valid values
are: "S" = scalar, "V" = vector, and "T" = tensor.
STRING form[] This value specifies the complex form to use. Valid
values are: Real, Imaginary, Magnitude,
Phase, and Angle.
REAL angle This value specifies the angle in radians to be used
with the Angle form. Optional=0.0.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
If the complex form is not explicitly set with this call, Real will be used as a default. See the description
for the input value form.
Example:
Description:
This function returns the next available unused register identifier of the specified location and type.
Input:
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and "EL"
= element.
STRING register_type[] This value specifies the register type. Valid values are:
"S" = scalar, "V" = vector, and "T" = tensor.
Output:
INTEGER <Return Value> The return value is the next available unused register
identifier.
Error Conditions:
None.
Remarks:
None.
Example:
Description:
This function returns 0 or 1 depending on whether or not the register has been defined.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and "EL"
= element.
STRING register_type[] This value specifies the register type. Valid values are:
"S" = scalar, "V" = vector, and "T" = tensor.
Output:
LOGICAL <Return Value> This value returns TRUE when the input register
identifier has an existing definition stored in the
database, or FALSE otherwise.
Error Conditions:
None.
Remarks:
None.
Example:
Please see res_data_defined (p. 1052) in the PCL Reference Manual Examples.
Chapter 6: Results Postprocessing Functions 1483
Data Register Query Functions
Description:
This function dumps the data of the specified register to a file.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the results data
is associated. Valid values are: "C" = centroid, "N" = nodal, "EN"
= element nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid values are: "S" =
scalar, "V" = vector, and "T" = tensor.
STRING file_name[] This value specifies the file name to dump a registers data into.
STRING file_options[] This value specifies the file options controlling the types of read
and write operations that may be done to the file. See the remarks
below for more information.
Output:
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The input value file_options can make use of the following values. This values can be concatenated
together to specify more that one option at a time:
1484 PCL Reference Manual
Data Register Query Functions
Option Description
Example:
Please see res_data_dump (p. 1053) in the PCL Reference Manual Examples.
Chapter 6: Results Postprocessing Functions 1485
Data Register Query Functions
Description:
This function dumps the coordinate system information to a file from all defined registers.
Input:
STRING file_name[] This value specifies the file name to dump a registers
coordinate data into.
STRING file_options[] This value specifies the file options controlling the
types of read and write operations that may be done to
the file. See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The input value file_options can make use of the following values. This values can be concatenated
together to specify more that one option at a time:
1486 PCL Reference Manual
Data Register Query Functions
Option Description
Example:
Description:
This function dumps the register data pattern information to a file from all defined registers.
Input:
STRING file_name[] This value specifies the file name to dump a registers
pattern data into.
STRING file_options[] This value specifies the file options controlling the types
of read and write operations that may be done to the file.
See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The input value file_options can make use of the following values. This values can be concatenated
together to specify more that one option at a time:
1488 PCL Reference Manual
Data Register Query Functions
Option Description
Example:
Description:
This function outputs the registers data source type.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the results
data is associated. Valid values are: "C" = centroid, "N" =
nodal, "EN" = element nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid values are: "S" =
scalar, "V" = vector, and "T" = tensor.
Output:
STRING source_type[] This value returns the source type. Valid values are: Db,
LBC, FEMAttrib, EProp, User, and Derived.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The data source type for a register corresponds to the load method used for that register. If the register
data is not from a single source, the type will be derived.
Example:
Description:
This function outputs the stored information regarding a register containing a database result.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and "EL"
= element.
STRING register_type[] This value specifies the register type. Valid values are:
"S" = scalar, "V" = vector, and "T" = tensor.
Output:
STRING load_case[] This value returns the load case identifier.
STRING subcase[] This value returns the subcase identifier.
STRING primary_result[] This value returns the primary result identifier.
STRING secondary_result[] This value returns the secondary result identifier.
STRING layer[] This value returns the layer position identifier.
STRING derivation[10] This value returns the derivation specifier.
STRING coordinate[] This value returns the coordinate system for
transformations.
STRING average_method[] This value returns the defined averaging method.
STRING average_domain[] This value returns the defined averaging domain.
STRING extrapolation[] This value returns the defined extrapolation method.
LOGICAL list_flag This value returns a value of TRUE if the register has an
associated list.
LOGICAL layer_flag This value returns TRUE if the register has an associated
layer.
STRING data_form[] This value returns the data form (real, imaginary, etc.).
Optional = NULL.
REAL complex_angle This value returns the complex angle. Optional =
NULL.
Chapter 6: Results Postprocessing Functions 1491
Data Register Query Functions
Remarks:
None.
Example:
Description:
This function returns a subcase name given the load case and subcase identifiers. It returns the name
of a subcase including any extension added to distinguish it from other subcases with the same name.
("_nn")
Input:
INTEGER load_case This value specifies the load case identifier.
INTEGER subcase This value specifies the subcase identifier.
Output:
STRING subcase_name[] This value returns the subcase name.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function returns the subcase identifier given the load case and subcase names.
Input:
STRING load_case[] This value specifies the load case name.
STRING subcase[] This value specifies the subcase name.
Output:
INTEGER subcase_id This value returns the subcase identifier.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
The function returns the primary and secondary result names given their identifiers.
Input:
INTEGER primary_result This value specifies the primary result identifier.
INTEGER secondary_result This value specifies the secondary result identifier.
Output:
STRING primary_name[] This value returns the primary result name.
STRING secondary_name[] This value returns the secondary result name.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function returns the primary and secondary results identifiers given their names.
Input:
STRING primary_name[] This value specifies the primary result name.
STRING secondary_name[] This value specifies the secondary result name.
Output:
INTEGER primary_result This value returns the primary result identifier.
INTEGER secondary_result This value returns the secondary result identifier.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function returns the layer position name given layer identifier.
Input:
INTEGER layer_id This value specifies the layer position identifier.
Output:
STRING layer_name[] This value returns the layer position name.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages (p. 1877) in the PCL Reference Manual for information on any error values
returned by this function.
Remarks:
None.
Example:
Description:
This function returns the layer position identifier given its name.
Input:
STRING layer_name[] This value specifies the layer position name.
Output:
INTEGER layer_id This value returns the layer position identifier.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
1496 PCL Reference Manual
Data Register Query Functions
Remarks:
None.
Example:
Description:
This function retrieves the number of load cases and all their load case, subcase, and coordinate
identifiers that exist in the database and the names associated to them.
Input:
Output:
INTEGER count This value returns the number of load cases.
INTEGER load_case_ids(count This value returns the load case identifiers.
)
INTEGER subcase_ids(count) This value returns the subcase identifiers.
INTEGER coordinates(count) This value returns the coordinate identifiers
associated with the load cases.
STRING load_case[](count) This value returns the load case names.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function returns the primary and secondary result identifiers given the results type identifier.
Input:
INTEGER restype_id This value specifies the results type identifier.
Output:
INTEGER primary_result This value returns the primary result identifier.
INTEGER secondary_result This value returns the secondary result identifier.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function deletes the current definition of the specified register.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the results
data is associated. Valid values are: "C" = centroid, "N" =
nodal, "EN" = element nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid values are: "S"
= scalar, "V" = vector, and "T" = tensor.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function saves all of the possible data available for the specified register in the database as a
result.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and
"EL" = element.
STRING register_type[] This value specifies the register type. Valid values
are: "S" = scalar, "V" = vector, and "T" = tensor.
STRING load_case[] This value specifies the load case identifier.
STRING subcase[] This value specifies the subcase identifier.
STRING layer[] This value specifies the layer position identifier.
STRING primary_result[] This value specifies the primary result identifier.
STRING secondary_result[] This value specifies the secondary result identifier.
INTEGER num_entities The number of entities in entity list. Default is 0. If
value is 0 then PATRAN automatically generates a
list of entities to associate with the results.
STRING entity_list The picklist of entities to associate to the results. If
this argument is not existent, PATRAN automatically
associates the results with appropriate entities [no
default value].
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
The data register result is associated with the specified, existing, loadcase and subcase. It is given the
primary and secondary result titles specified by the input value primary_result and secondary_result.
1500 PCL Reference Manual
Data Register Operator Functions
Example:
Description:
This function returns information about an attached file.
Input:
STRING szFileName [max The attached source file name.
256]
Output:
INTEGER iSourceFileId Internal database ID of the attached file.
INTEGER iFileType Internal handle not intended for usage for the PCL
programmer.
INTEGER iParamSetId Internal handle not intended for usage for the PCL
programmer.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
MSG_RES_CANNOTOPENFILE File does not exist.
Remarks:
This function is to be used to retrieve information needed to call the res_dra_detach_file. The
undocumentred parameters are not to be used anywhere as their values are internal to DRA and they are
subject to change without any notification.
Example:
None .
1502 PCL Reference Manual
Direct Results Access
res_dra_detach_file (src_file_id,result_type,paramrset_id)
Description:
This function returns information about an attached file.
Input:
INTEGER src_file_id The source File handle for the file one would like to detach.
INTEGER result_type Un-used parameter. You may pass any dummy parameter you
like as its value will be ignored.
INTEGER Paramset_id Parameter set ID handle as obtained by the call to
res_dra_get_res_file_by_name( ).
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
None.
Chapter 6: Results Postprocessing Functions 1503
Direct Results Access
Description:
This function specifies a format function used to determine the data values of a register.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the results
data is associated. Valid values are: "C" = centroid, "N" =
nodal, "EN" = element nodal, and "EL" = element.
STRING register_type[] This value specifies the register type. Valid values are: "S"
= scalar, "V" = vector, and "T" = tensor.
STRING function[] This value specifies a PCL function such as ($1 + $2 / $4)
* $5. The $n specifiers are register identifiers.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Remarks:
The registers specified in the function must be of the same location and type and must have been
previously loaded with a res_data_load() function.
Example:
None.
1504 PCL Reference Manual
Results Display Manager
Freefaces FreeEdges
AllFaces AllEdges
Elements Nodes
Corners Isosurfaces
Streamlines Path
The display tool target definition attributes are optional. The entities corresponding to the display tool
entity type found in the current viewport will be used as the default target definition if the target definition
is not defined. Valid target definitions on which plots can be displayed are:
Value Description
NO Nodes
EL Elements
GR Groups
PR Properties
MA Materials
ET Element Types
IS Isosurface
SL Streamline
DF Deformed
PP Path Point
PC Path Curve
PE Path Edge
If specific deformation tools are targeted by a display tool, the display tool will be repeatedly displayed
in the deformed state described by each of the specified posted deformation tools. Specific deformation
1506 PCL Reference Manual
Plot Tool Creation and Modification Functions
tool targets are not required unless specific deformed states are to be used, and multiple deformed states
are posted simultaneously in the same viewport. An input value to the function being called is used in
most situations to control if a display tool is to be shown in a deformed, when set to TRUE, or
undeformed, when set to FALSE, state.
The display tool display attributes are used to control the display settings associated with each tool type
attribute. They are string values in the form keyword:value(s). If multiple values are used for a given
keyword, each value is separated by a comma. Here are some definitions for common values used by
multiple tool attribute keywords throughout the following PCL function definitions:
Description:
This function creates a fringe plot tool definition.
Input:
STRING plot_name[] This value specifies the name of the plot: either or a
unique name.
STRING entity_type[] This value specifies the entity type. Valid values are:
FreeFaces, AllFaces, FreeEdges, and
AllEdges.
INTEGER ntargets This value specifies the number of strings in the input
value targets. If this value is set to 0, all the entities
specified by the input value entity_type will be used.
STRING targets[](ntargets) This value specifies the target specifications. See the
remarks below for more information.
INTEGER nattribs This value specifies the number of offsets in the input
value attributes.
STRING attributes[](nattribs) This value specifies the attributes. See the remarks
below for more information.
LOGICAL deformed_flag This value is set to TRUE to enable displaying in the
deformed shape if deformation tools are posted
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The input value targets can be set as follows. The keyword should be separated from the values by a colon
or :
The input value attributes can be set as follows. The keyword should be separated from the values by a
colon or :
Keyword Values
Range <name>
RangeOverwrite <onoff>
FringeStyle <style>
Shade <filltype>
ElemEdge <edgestyle,color,style,width>
Shrink <percent>
TitleDisplay <onoff>
MinMaxDisplay <onoff>
ValueDisplay <onoff>
Filter <method>
ScaleFactor <value>
LabelStyle <display,fontsize,color,digits>
Example:
Description:
This function modifies a fringe plot tool definition.
Input:
STRING plot_name[] This value specifies the name of the plot: either
or a unique name.
STRING new_name[] This value specifies a new name to give the plot.
STRING entity_type[] This value specifies the entity type. Valid values
are: FreeFaces, AllFaces, FreeEdges, and
AllEdges.
INTEGER ntargets This value specifies the number of strings in the
input value targets. If this value is set to 0, all the
entities specified by the input value entity_type
will be used.
STRING targets[](ntargets) This value specifies the target specifications. See
the res_display_fringe_create() function for more
information.
INTEGER nattribs This value specifies the number of offsets in the
input value attributes.
STRING attributes[](nattribs This value specifies the attributes. See the remarks
) below for more information.
LOGICAL deformed_flag This value is set to TRUE to enable displaying in
the deformed shape if deformation tools are posted
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
Description:
This function creates a vector plot tool definition.
Input:
STRING plot_name[] This value specifies the name of the plot: either or a
unique name.
STRING entity_type[] This value specifies the entity type. Valid values are:
Nodes, Elements, Corners, FreeFace, and
FreeEdge.
INTEGER ntargets This value specifies the number of strings in the input
value targets. If this value is set to 0, all the entities
specified by the input value entity_type will be used.
STRING targets[](ntargets) This value specifies the target specifications.
INTEGER nattribs This value specifies the number of offsets in the input
value attributes. This value should be set to 16.
STRING attributes[](nattribs) This value specifies the attributes for the vector tool.
See the remarks below for more information.
LOGICAL deformed_flag This value is set to TRUE to enable displaying in the
deformed shape if deformation tools are posted
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The input value attributes can make use of the following keywords and values. The keyword and the
values should be separated by a colon or :
Keyword Values
Range <name>
RangeOverwrite <onoff>
VectorDisplay <display>
VectorComps <onoff>[,<onoff>, <onoff>]
VectorColors <color>[,<color>,<color>]
VectorScale <scaledef>
VectorAttachment <location>
HeadStyle <style>
VectorStyle <style>
TailDisplay <onoff>
TitleDisplay <onoff>
MinMaxDisplay <onoff>
LabelStyle <display,fontsize,color,digits>
ValueDisplay <onoff>
Filter <method>
ScaleFactor <value>
1512 PCL Reference Manual
Plot Tool Creation and Modification Functions
Example:
Description:
This function modifies a vector plot tool definition.
Input:
STRING plot_name[] This value specifies the name of the plot: either or a
unique name.
STRING new_name[] This value specifies a new name to give the plot.
STRING entity_type[] This value specifies the entity type. Valid values are:
Nodes, Elements, Corners, FreeFace, and
FreeEdge.
INTEGER ntargets This value specifies the number of strings in the input
value targets. If this value is set to 0, all the entities
specified by the input value entity_type will be used.
STRING targets[](ntargets) This value specifies the target specifications. See the
res_display_vector_create() function for more
information.
INTEGER nattribs This value specifies the number of offsets in the input
value attributes.
STRING attributes[](nattribs) This value specifies the attributes. See the
res_display_vector_create() function for more
information.
LOGICAL deformed_flag This value is set to TRUE to enable displaying in the
deformed shape if deformation tools are posted
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.
Remarks:
Example:
Description:
This function creates a tensor plot tool definition.
Input:
STRING plot_name[] This value specifies the name of the plot: either or a
unique name.
STRING entity_type[] This value specifies the entity type. Valid values are:
Nodes, Elements, Corners, FreeFace, and
FreeEdge.
INTEGER ntargets This value specifies the number of strings in the input
value targets. If this value is set to 0, all the entities
specified by the input value entity_type will be used.
STRING targets[](ntargets) This value specifies the target specifications. See the
remarks below for more information.
INTEGER nattribs This value specifies the number of offsets in the input
value attributes. This value should be set to 17.
STRING attributes[](nattribs) This value specifies the attributes. See the remarks below
for more information.
LOGICAL deformed_flag This value is set to TRUE to enable displaying in the
deformed shape if deformation tools are posted
Output:
INTEGER <Return Value> his function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The input value attributes can make use of the following keywords and values. The keyword should be
separated from the value by a colon or :
Chapter 6: Results Postprocessing Functions 1515
Plot Tool Creation and Modification Functions
Keyword Values
Range <name>
RangeOverwrite <onoff>
TensorDisplay <display>
TensorComps <onoff>,<onoff>, <onoff>,<onoff>,<onoff>, <onoff>
TensorColors <color>[,<color>,<color>]
VectorScale <scaledef>
VectorAttachment <location>
HeadStyle <style>
VectorStyle <style>
TailDisplay <onoff>
TitleDisplay <onoff>
MinMaxDisplay <onoff>
LabelStyle <display,fontsize,color,digits>
ValueDisplay <onoff>
Filter <method>
ScaleFactor <value>
Example:
Description:
This function modifies a tensor plot tool definition.
Input:
STRING plot_name[] This value specifies the name of the plot: either or a
unique name.
STRING new_name[] This value specifies a new name to give the plot.
STRING entity_type[] This value specifies the entity type. Valid values are:
Nodes, Elements, Corners, FreeFace, and
FreeEdge.
INTEGER ntargets This value specifies the number of strings in the input
value targets. If this value is set to 0, all the entities
specified by the input value entity_type will be used.
STRING targets[](ntargets) This value specifies the target specifications. See the
res_display_tensor_create() function for more
information.
INTEGER nattribs This value specifies the number of offsets in the input
value attributes.
STRING attributes[](nattribs) This value specifies the attributes. See the
res_display_tensor_create() function for more
information.
LOGICAL deformed_flag This value is set to TRUE to enable displaying in the
deformed shape if deformation tools are posted
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Description:
This function creates a report tool definition.
Input:
STRING report_name[] This value specifies the name of the report: either
or a unique name.
STRING entity_type[] This value specifies the entity type. Valid values are:
Nodes, and Elements.
INTEGER ntargets This value specifies the number of strings in the
input value targets. If this value is set to 0, all the
entities specified by the input value entity_type will
be used.
STRING targets[](ntargets) This value specifies the target specifications. See the
remarks below for more information.
INTEGER nattribs This value specifies the number of offsets in the
input value attributes.
STRING attributes[](nattri This value specifies the attributes. See the remarks
bs) below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The input value attributes can make use the following values. The keyword should be separated from the
value by a colon or :
Keyword Values
ReportType <type>
ReportTitle <title> - repeat for all title lines
ReportHeader <text> - repeat for all header lines
ReportFooter <text> - repeat for all footer lines
ReportPage height=<lines>,
width=<characters>,TopMargin=<line>,LeftMargin=<characters
>,BottomMargin=<characters>
ReportPagination <onoff>
ReprotPageNumber <startnumber>
ReportPageAlignment <location>
ReportVColumn <column#>, <Heading>, <value keyword>, <format> - repeat for
each column
EntitySort <method>
ValueSort <column>,<order>,<method>
Filter <method>
ScaleFactor <value>
The attributes will define the output. There can be multiple ReportHeader and ReportFooter definitions.
They will be used in order as written. The following special strings can be inserted in Header and Footer
definitions
Chapter 6: Results Postprocessing Functions 1519
Plot Tool Creation and Modification Functions
The report column value keywords are scalar derivation strings defined for the registers as well as the
following values:
Example:
Description:
This function modifies a report tool definition.
Input:
STRING report_name[] This value specifies the name of the report: either or
a unique name.
STRING new_name[] This value specifies a new name to give the report.
STRING entity_type[] This value specifies the entity type. Valid values are:
Nodes, or Elements.
INTEGER ntargets This value specifies the number of strings in the input
value targets. If this value is set to 0, all the entities
specified by the input value entity_type will be used.
STRING targets[](ntargets) This value specifies the target specifications. See the
res_display_report_create() function description for
more information.
INTEGER nattribs This value specifies the number of offsets in the input
value attributes.
STRING attributes[](nattribs) This value specifies the attributes. See the
res_display_report_create() function description for
more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Description:
This function creates a graph plot tool definition.
Input:
STRING plot_name[] This value specifies the name of the plot: either
or a unique name.
STRING graph_type[] This value specifies the X vs Y graph type:
GVGV = global variable vs. global variable,
DataGV = result vs. global variable, DataData
= results vs. result, DataLocation = result vs.
coordinate location, and DataDistance = result vs.
curve or beam distance.
STRING entity_type[] This value specifies the entity type. Valid values are:
Nodes, Elements, and Path.
INTEGER ntargets This value specifies the number of strings in the
input value targets. If this value is set to 0, all the
entities specified by the input value entity_type will
be used.
STRING targets[](ntargets) This value specifies the target specifications. See
the remarks below for more information.
INTEGER nattribs This value specifies the number of offsets in the
input value attributes.
STRING attributes[](nattribs This value specifies the attributes. See the remarks
) below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The input value attributes can make use the following values. The keyword should be separated from the
value by a colon or :
Keyword Values
curveFitMethod <method>
curveStyle <style>
symbolDisplay <onoff.>
xAxisLabelDisplay <onoff>
xAxisLabel <text>
xAxisScale <scale>
xAxisLabelFormat <format>, <number>, < color>, <digits>
yAxisLabelDisplay <onoff>
yAxisLabel <text>
yAxisScale <scale>
yAxisLabelFormat <format>, <number>, < color>, <digits>
ScaleFactor <factor>
Chapter 6: Results Postprocessing Functions 1523
Plot Tool Creation and Modification Functions
Example:
Description:
This function modifies a graph plot tool definition.
Input:
STRING plot_name[] This value specifies the name of the plot: either or
a unique name.
STRING new_name[] This value specifies a new name to give the plot.
STRING graph_type[] This value specifies the X vs Y graph type: GVGV
= global variable vs. global variable, DataGV =
result vs. global variable, DataData = results vs.
result, DataLocation = result vs. coordinate
location, and DataDistance = result vs. curve or
beam distance.
STRING entity_type[] This value specifies the entity type. Valid values are:
Nodes, Elements, and Path.
INTEGER ntargets This value specifies the number of strings in the input
value targets. If this value is set to 0, all the entities
specified by the input value entity_type will be used.
STRING targets[](ntargets) This value specifies the target specifications. See the
res_display_graph_create() function description for
more information.
INTEGER nattribs This value specifies the number of offsets in the input
value attributes.
STRING attributes[](nattribs) This value specifies the attributes. See the
res_display_graph_create() function description for
more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
1524 PCL Reference Manual
Plot Tool Creation and Modification Functions
Remarks:
Example:
Description:
This function creates a deformation plot tool definition.
Input:
STRING plot_name[] This value specifies the name of the plot: either or
a unique name.
STRING entity_type[] This value specifies the entity type. Valid values are:
Nodes, and Elements.
INTEGER ntargets This value specifies the number of strings in the input
value targets. If this value is set to 0, all the entities
specified by the input value entity_type will be used.
STRING targets[](ntargets) This value specifies the target specifications. Valid
values are: NO = list is for a node list, EL = list is
for an element list, GR = name is for a group name,
PR = name for a specific property set, MA = name
for a material, and ET = type for element type
(point,beam, tri, ...).
INTEGER nattribs This value specifies the number of offsets in the input
value attributes.
STRING attributes[](nattribs) This value specifies the attributes. See the remarks
below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Chapter 6: Results Postprocessing Functions 1525
Plot Tool Creation and Modification Functions
Remarks:
DeformedStyle keywords consist of any valid color, a line style of Solid, Dash or Dot, and a
thickness value between 1 and 10 and a render style of either Wireframe, Shaded, HiddenLine, or
FreeEdge. The same is true for UndeformedStyle.
The DeformedScale keyword is either True or Model=percentage.
LabelStyle display includes Fixed, Integer, or Exponential. The fontsize is any valid font size as
an integer value. The color is any valid color name. The digits is the number of significant digits to retain.
The input value attributes can make use the following values. The keyword should be separated from the
value by a colon or :
Keyword Values
DeformedStyle <color>,<style>,<thickness>,<render>
DeformedScale <method>[=factor]
UndeformedStyle <onoff>,<color>,<style>,<thickness>,<render>
TitleDisplay: <onoff>
MinMaxDisplay <onoff>
ScaleFactor <value>
LabelStyle <display,fontsize,color,digits>
Example:
Description:
This function specifies a fringe plot tool definition.
Input:
STRING plot_name[] This value specifies the name of the plot: either or a
unique name.
STRING new_name[] This value specifies a new name to give the plot.
STRING entity_type[] This value specifies the entity type. Valid values are:
Nodes, or Elements.
INTEGER ntargets This value specifies the number of strings in the input
value targets. If this value is set to 0, all the entities
specified by the input value entity_type will be used.
STRING targets[](ntargets) This value specifies the target specifications. See the
res_display_deformation_create() function for more
information.
INTEGER nattribs This value specifies the number of offsets in the input
value attributes.
STRING attributes[](nattribs) This value specifies the attributes. See the
res_display_deformation_create() function for more
information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function posts a fringe plot tool definition to the current viewport.
Input:
STRING plot_name[] This value specifies the name of the existing plot: either
or an existing name.
INTEGER register_id This value specifies the scalar register id (of location
specified) containing data definition.
STRING register_location[] This value specifies the location of the data: either "C" =
centroid, "N" = nodal, or "EN" = element nodal.
LOGICAL range_flag This value is set to TRUE to flag this tool to control the
range info in the viewport.
LOGICAL spectrum_flag This value is set to TRUE to display the spectrum bar
with this plot. Optional=TRUE.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function posts a vector plot tool definition to the current viewport.
Input:
STRING plot_name[] This value specifies the name of the existing plot:
either or an existing name.
INTEGER register_id This value specifies the vector register id (of
location specified) containing data definition.
STRING register_location[] This value specifies the location of the data: either
"C" = centroid, or "N" = nodal.
LOGICAL range_flag This value is set to TRUE to flag this tool to
control the range info in the viewport.
LOGICAL spectrum_flag This value is set to TRUE to display the spectrum
bar with this plot. Optional=TRUE.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function posts a tensor plot tool definition to the current viewport.
Input:
STRING plot_name[] This value specifies the name of the existing plot:
either or an existing name.
INTEGER register_id This value specifies the tensor register id of the
location specified containing the data definition.
STRING register_location[] This value specifies the location of the data: either "C"
= centroid, or "N" = nodal.
LOGICAL range_flag This value is set to TRUE to flag this tool to control the
range info in the viewport.
LOGICAL spectrum_flag This value is set to TRUE to display the spectrum bar
with this plot. Optional=TRUE.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function posts a deformation plot tool definition to the current viewport.
Input:
STRING plot_name[ This value specifies the name of the existing plot: either or an
] existing name.
INTEGER register_id This value specifies the vector register id of the location specified
containing the data definition.
Output:
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
None.
Chapter 6: Results Postprocessing Functions 1531
Plot Tool Manipulation Functions
Description:
This function writes a report tool definition to the specified file.
Input:
STRING report_name[] This value specifies the name of the report: either or
an existing name.
INTEGER register_id This value specifies the nodal vector register id of the
location specified containing the data definition.
STRING register_type[] This value specifies the register type. Valid values are:
"S" = scalar, "V" = vector, and "T" = tensor.
STRING register_location[] This value specifies the location of the data: either "C"
= centroid, "N" = nodal, "EN" = element nodal, or "EL"
= element.
STRING output_method[] This value specifies the output method: either
STDOUT, NewFile, Overwrite, or Append.
STRING file_name[] This value specifies the name of the file to which the
report definition will be written.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function posts a fringe plot tool definition to the current viewport.
Input:
STRING plot_name[] This value specifies the name of the plot: either
or an existing name.
STRING register_location[] This value specifies the data location: either "C" =
centroid, "N" = nodal, "EN" = element nodal, or
"EL" = element.
INTEGER y_register_id This value specifies the nodal vector register id of
the location specified containing the data
definition.
INTEGER x_register_id This value specifies the nodal vector register id of
the location specified containing the data
definition.
STRING plot_title[] This value specifies the plot title.
LOGICAL append_flag This value specifies, when set to TRUE, that
curves are to be appended end to end. When this
value is set to FALSE, curves will not be appended
end to end.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function unposts a plot tool from the current viewport.
Input:
STRING plot_type[] This value specifies the type of plot. See the remarks below
for more information.
STRING plot_name[] This value specifies the name of the plot to unpost.
Output:
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
Description:
This function posts a fringe plot tool definition to the current viewport.
Input:
STRING plot_type[] This value specifies the type of plot. See the remarks below for
more information.
STRING plot_name[] This value specifies the name of the plot to unpost.
Output:
1534 PCL Reference Manual
Plot Tool Manipulation Functions
LOGICAL <Return This function returns TRUE if the plot tools exists, and FALSE
Value> otherwise.
Error Conditions:
None.
Remarks:
Example:
Description:
This function deletes a plot tool definition from the database.
Input:
STRING plot_type[] This value specifies the type of plot. See the remarks
below for more information.
STRING plot_name[] This value specifies the name of the plot to unpost.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
Animation Functions
The following functions are used for animation.
Description:
This function specifies a sinusoid or linear ramp variation to be used in a subsequent animation
sequence for a tool posted in the current viewport.
Input:
STRING method[] This value specifies the method of animation: either
modal, or ramp.
STRING plot_type[] This value specifies the type of plot tool. See the remarks
below for more information.
STRING plot_name[] This value specifies the name of the plot tool: either or an
existing posted tool name.
REAL init_angle This value specifies the angle in radians to start the
animation. This value is used mostly for modal animations
where you might want to start animation, say 90 degrees out
of phase.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The COSINE function will be used for the modal data scale factor.
A linear ramp from 1 to 0 will be used for a ramped animation.
The input value plot_type can be set to the following values:
Example:
None.
Description:
This function specifies a register list index is to be used in a subsequent animation sequence for a plot
tool posted in the current viewport.
Input:
STRING plot_type[] This value specifies the type of plot tool. See the remarks
below for more information.
STRING plot_name[] This value specifies the name of the plot tool: either or
an existing posted tool name.
INTEGER start_index This value specifies any number between 1 and N-1, where
N is the number of data sets specified in the register list as
explained below.
INTEGER end_index This value specifies any number between start_index+1
and N.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The indices for this function are 1 through N, corresponding to the N data sets specified by the defined
register list.
This tool must be currently associated to a register containing a register list defined using the
res_data_dbres_list() or res_data_register_list() functions.
The input value plot_type can be set to the following values:
Example:
None.
Description:
This function specifies a subsequent animation to be created using the specified global variable.
Input:
STRING plot_type[] This value specifies the type of plot tool. See the
remarks below for more information.
STRING plot_name[] This value specifies the name of the plot tool: either
or an existing posted tool name.
STRING global_name[] This value specifies the global variable name.
REAL init_value This value specifies the starting global variable value.
REAL end_value This value specifies the ending global variable value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The global variable specified by the input value global_name must be associated with the data sets in the
register list of the plot tool.
The values in the tools register list correspond to the data set global variable values to be traversed during
the animation.
The input value plot_type can be set to the following values:
Example:
None.
Description:
This function turns off the animation of a particular plot tool.
Input:
STRING plot_type[] This value specifies the type of plot tool. See the
remarks below for more information.
STRING plot_name[] This value specifies the name of the plot tool: either
or an existing posted tool name.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
None.
1540 PCL Reference Manual
Animation Functions
Description:
This function retrieves animation definitions for a particular plot tool.
Input:
STRING plot_type[] This value specifies the type of plot tool. See the remarks
below for more information.
STRING plot_name[] This value specifies the name of the plot tool: either or
an existing posted tool name.
Output:
STRING method[] This value returns the animation method for the current
animation.
INTEGER start_index This value returns the starting index for the current
animation.
INTEGER end_index This value returns the ending index for the current
animation.
STRING global_name[] This value returns the global variable associated with the
current animation.
REAL init_value This value returns the initial value of the global variable
for this animation.
REAL end_value This value returns the ending value of the global variable
associated with this animation.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
None.
res_display_anim_setup_2d (number_frames,
interp_method, file_name)
Description:
This function specifies the number of frames and interpolation method to be used for creating a 2D
image animation.
Input:
INTEGER number_frames This value specifies the number of animation
frames to create.
STRING interp_method[] This value specifies the method of interpolation for
transient animation to create frames when actual
existing data does not exist for that frame. Valid
values are: Linear, Spline, Closest, and
None.
STRING file_name[] This value specifies the root file name for
animation files to be created in conjunction with
the animation process. The animation files will not
be created if this value is set to an empty string or
.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The interpolation factor is used for any tool animating from a register list.
Example:
Description:
This function specifies the number of frames and interpolation method to be used for creating a 3D
display list animation.
Input:
INTEGER number_frames This value specifies the number of animation frames
to create.
STRING interp_method[] This value specifies the method of interpolation for
transient animation to create frames when actual
existing data does not exist for that frame. Valid
values are: Linear, Spline, Closest, and
None.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The interpolation factor is used for any tool animating from a register list.
Example:
res_display_anim_image_create (file_name)
Description:
This function creates an image file of the current viewport.
Input:
STRING file_name[] This value specifies the file name to which the image will
be dumped.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function specifies the files containing images to be read in and used as animation frames.
Input:
INTEGER n_frames This value specifies the number of animation frames
to create.
STRING file_name[](n_frames) This value specifies the names of the files containing
image information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
1544 PCL Reference Manual
Animation Functions
Remarks:
None.
Example:
Description:
This function modifies the bounds of the frames used by a running animation.
Input:
INTEGER current_frame This value specifies the frame to display upon execution.
INTEGER start_frame This value specifies the lower bound of the frames to
display.
INTEGER end_frame This value specifies the upper bound of the frames to
display.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
res_display_anim_method (method)
Description:
This function modifies the method of paging from frame to frame during an animation.
Input:
STRING method[] This value specifies the animation method. Valid values
are: Cycle (1->n,1->n) and Bounce (1<->n).
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
res_display_anim_run (delay)
Description:
This function starts the running of an animation at a specific frame rate and can also be used to modify
the frame rate of a running animation process.
Input:
INTEGER delay This value specifies the delay in milliseconds
between frame display calls. Setting this value to 0
will produce the maximum frame refresh rate.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
1546 PCL Reference Manual
Animation Functions
Remarks:
None.
Example:
res_display_anim_step ()
Description:
This function stops any running animation and displays the next frame in the queue.
Input:
None.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
This function can be used to stop animation sequences started with a call to the res_dipslay_anim_run()
function.
Example:
res_display_anim_frame (frame_number)
Description:
This function displays an animation frame and stops any running animation.
Input:
INTEGER frame_number This value specifies the frame number of the animation
to display.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
res_display_anim_clear ()
Description:
This function stops any running animation and clears any stored animation frames from memory.
Input:
None.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
1548 PCL Reference Manual
Animation Functions
Example:
res_display_anim_active ()
Description:
This function queries whether an animation is active or not.
Input:
None.
Output:
LOGICAL <Return Value> This function returns TRUE if an animation is active,
and FALSE otherwise.
Error Conditions:
None.
Remarks:
None.
Example:
Description:
Saves the result animation to file.
Input:
STRING file_type VRML or MPEG
STRING plot_type Plot type being animated: quick, Deformation,
Fringe, Vector, Lines
INTEGER frames Number of frames in the animation
STRING interpolation Interpolation option: Linear, Closest, None
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Remarks:
None.
Example:
None.
1550 PCL Reference Manual
Animation Functions
Description:
This function returns the status of an animation in the current viewport.
Input:
None.
Output:
INTEGER current_frame This value returns the current frame displayed in the
current animation.
INTEGER start_frame This value returns the starting frame number of the
current animation.
INTEGER end_frame This value returns the ending frame number of the
current animation.
INTEGER number_frame This value returns the number of frames in the current
animation.
INTEGER delay This value returns the delay (in milliseconds) of the
current animation.
INTEGER disp_method This value returns the display method of the current
animation.
INTEGER anim_status This value returns the status of the current animation.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Chapter 6: Results Postprocessing Functions 1551
Animation Functions
res_display_cleanup ()
Description:
This function cleans up the graphical display and returns the graphics to a wireframe state.
Input:
None.
Output:
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function specifies the number of frames and graphics method to be used for creating an image
animation.
Input:
INTEGER number_frames This value specifies the number of animation frames to
create.
STRING graphics_method[] This value specifies the graphics method for animation.
Valid values are: "2D", "3D", "Preview", and "MPEG".
STRING string[] For future use. Set value to an empty string.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None
Example:
None
Chapter 6: Results Postprocessing Functions 1553
Quick Plot Functions
Description:
This function specifies a result to be extracted and manipulated into a format for subsequent display.
Input:
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and
"EL" = element.
STRING result_type[] This value specifies the results data type. Valid
values are: "S" = scalar, "V" = vector, and "T" =
tensor.
STRING primary_result[] This value specifies the identifier of the primary
result.
STRING secondary_result[] This value specifies the identifier of the secondary
result.
STRING layer[] This value specifies the layer position identifier.
STRING derivation[10] This value specifies the derivation specifier if the
results are to be derived. A null will leave the result
as is. See the remarks in res_data_load_dbresults()
for more information.
STRING coordinate[] This value specifies the coordinate for
transformations. Valid values are: = as is, Coord
i = Db coordinate system, "M" = material system,
"IJK" = element ijk system, "N" = nodal system, and
"G" = global.
STRING averaging_method[ This value specifies the averaging method: derive-
] avg to perform derivations and transformations,
then average the results, avg-derive (transform to
global, average, then derive/transform),
difference (calculate the difference versus
average, derivations performed first), and sum
(sum all of the element nodal components at the
nodes).
STRING averaging_domain[ This value specifies the averaging domain: All,
] Matl, Prop, Target (only consider entities in
the target definition), and Element.
1554 PCL Reference Manual
Quick Plot Functions
Remarks:
None.
Description:
This function specifies the element layer information.
Input:
STRING derivation[] This value specifies the results data be scanned for the
maximum, minimum, summation, or averaged
values. Valid values are: "MAXIMUM",
"MINIMUM", "SUM", and "AVERAGE".
INTEGER count This value specifies the number of layers selected.
STRING layers[](count) This value specifies the layer position labels.
Output:
None
Error Conditions:
None
Remarks:
None
Chapter 6: Results Postprocessing Functions 1555
Quick Plot Functions
Example:
Note
.
res_display_anim_qk_fringe_ttle (title)
Description:
This function specifies a title string to be associated with the fringe plot. If this title is not specified, a
default title based on the source of the data will be used.
Input:
STRING title[] This value specifies the fringe title.
Output:
None
Error Conditions:
None
Remarks:
None.
Example:
None.
1556 PCL Reference Manual
Quick Plot Functions
Description:
This function creates a fringe plot tool definition.
Input:
INTEGER nattribs This value specifies the number of offsets in the input
value attributes.
STRING attributes[](nattribs) This value specifies the attributes. See remarks in
res_display_fringe_create() for more information.
LOGICAL deformed_flag This value is set to TRUE to enable displaying in the
deformed shape if deformation tools are posted
LOGICAL spectrum_flag This value is set to TRUE to display the spectrum bar
with this plot.
LOGICAL range_flag This value is set to TRUE to flag this tool to control the
range info in the viewport.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Description:
This function specifies a result to be extracted from the database and manipulated into a format for
subsequent display. This description will be stored in the specified register.
Input:
INTEGER register This value specifies the register identifier.
STRING location[] This value specifies the model entity with which the
results data is associated. Valid values are: "C" =
centroid, "N" = nodal, "EN" = element nodal, and
"EL" = element.
STRING result_type[] This value specifies the results data type. Valid
values are: "S" = scalar, "V" = vector, and "T" =
tensor.
STRING primary_result[] This value specifies the identifier of the primary
result.
STRING secondary_result[] This value specifies the identifier of the secondary
result.
STRING layer[] This value specifies the layer position identifier.
STRING derivation[10] This value specifies the derivation specifier if the
results are to be derived. A null will leave the result
as is. See the remarks in res_data_load_dbresults()
for more information.
STRING coordinate[] This value specifies the coordinate for
transformations. Valid values are: = as is, Coord
i = Db coordinate system, "M" = material system,
"IJK" = element ijk system, "N" = nodal system,
and "G" = global.
STRING averaging_method[] This value specifies the averaging method: derive-
avg to perform derivations and transformations,
then average the results, avg-derive (transform to
global, average, then derive/transform),
difference (calculate the difference versus
average, derivations performed first), and sum
(sum all of the element nodal components at the
nodes).
1558 PCL Reference Manual
Quick Plot Functions
Remarks:
None.
.
Description:
This function specifies a title string to be associated with the deformed plot. If this title is not specified,
a default title based on the source of the data will be used.
Input:
STRING titles[] This value specifies the fringe title.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Chapter 6: Results Postprocessing Functions 1559
Quick Plot Functions
Example:
None.
Description:
This function defines the deformation attributes for the plot tool definition.
Input:
INTEGER nattribs This value specifies the number of offsets in the input
value attributes.
STRING attributes[](nattribs) This value specifies the attributes. See the remarks
below for more information.
LOGICAL deformed_flag This value is set to TRUE to enable displaying in the
deformed shape if deformation tools are posted
LOGICAL spectrum_flag This value is set to TRUE to display the spectrum bar
with this plot.
LOGICAL range_flag This value is set to TRUE to flag this tool to control the
range info in the viewport.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
1560 PCL Reference Manual
Quick Plot Functions
Description:
This function specifies a series of database result specifiers to be associated with a specific register.
Input:
LOGICAL fringe_flag This value is set to TRUE to enable displaying in
the fringe.
LOGICAL deformed_flag This value is set to TRUE to enable displaying in
the deformed.
STRING graphics_method[] This value specifies the graphics method for
animation. Valid values are: "2D", "3D", "Preview",
and "MPEG".
STRING fringe_range This value specifies the fringe spectrum for display.
LOGICAL const_range_flag This value is set to TRUE to enable use a constant
range values the spectrum bar.
INTEGER num_cases This value specifies the number of result cases.
STRING load_case[](num_cases) This value specifies the load case identifiers.
STRING subcase[](num_cases) This value specifies the subcase identifiers.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None
Example:
None
Chapter 6: Results Postprocessing Functions 1561
Plot Tool Query Functions
res_display_get_ntools (plot_type)
Description:
This function returns the number of tools of the specified type.
Input:
STRING plot_type[] This value specifies the tool type. If this value is set to an
empty string or the count of all tools is returned. See
the remarks below for more information.
Output:
INTEGER <Return Value> This function returns the number of tools of the specified
type.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
Description:
This function returns the number of posted tools of the specified type.
Input:
STRING plot_type[] This value specifies the tool type. If this value is set
to an empty string or the count of all tools is
returned. See the remarks below for more
information.
INTEGER view_id This value specifies the viewport identifier. If this
value is set to 0, the number of posted tools for all
viewports will be returned.
Output:
INTEGER <Return Value> This function returns the number of posted tools of
the specified type.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
Description:
This function outputs the names and types of the posted tools.
Input:
STRING plot_type[] This value specifies the tool type. If this value is set to an
empty string or , the name and types of all tools is
returned. See the remarks below for more information.
INTEGER view_id This value specifies the viewport identifier. Optional=0.
Output:
STRING tools[](VIRTUAL) This value returns the plot tool names that are posted to
the specified viewport.
STRING types[](VIRTUAL) This value returns the plot types.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
Description:
This function outputs the color identifier of the input color string as it is used with the tool attribute
definitions.
Input:
STRING color_str[] This value specifies the input color. See the remarks
below for more information.
Output:
INTEGER color_id This value returns the color identifier of the specified
color.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
Description:
This function outputs the color string of the input color identifier as it is used with the tool attribute
definitions.
Input:
INTEGER color_id This value specifies the color identifier. This value
must be 0 or greater and less than 16.
Output:
STRING color_str[] This value returns the color associated with the given
identifier.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function outputs the size of the targets and attributes of the specified plot tool.
Input:
STRING plot_type[] This value specifies the tool type. If this value is set to an
empty string or , the target size and attributes of all tools
is returned. See the remarks below for more information.
STRING plot_name[] This value specifies the name of the plot tool.
Output:
INTEGER ntargets This value returns the number of targets defined.
INTEGER target_length This value returns the maximum length of a target string.
INTEGER nattribs This value returns the number of attributes defined.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
Description:
This function outputs the specified plot tool definition.
Input:
STRING plot_type[] This value specifies the tool type. If this value is set
to an empty string or , the definition of all tools is
returned. See the remarks below for more
information.
STRING plot_name[] This value specifies the name of the plot tool.
Output:
STRING ent_type[] This value returns the entity type specification.
INTEGER ntargets This value returns the number of target entities.
STRING targets[](ntargets) This value returns the target entities.
INTEGER nattribs This value returns the number of attributes
associated with this plot tool
STRING attributes[](nattribs This value returns the attributes of this plot tool.
)
LOGICAL deformed_flag This value returns the state of the deformed flag.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Isosurface and Streamline tools have additional parameters and are not supported by the get_tool function
but have their own get_ functions.
The input value plot_type can be set to the following values:
:
Example:
Description:
This function outputs the specified graph plot tool definitions.
Input:
STRING plot_name[] This value specifies the name of the graph plot tool.
Output:
STRING graph_type[] This value returns the graph type.
STRING entity_type[] This value returns the entity type.
INTEGER ntargets This value returns the number of targets.
STRING targets[](ntargets) This value returns the target values.
INTEGER nattribs This value returns the number of attributes associated
with this plot.
STRING attributes[](nattribs) This value returns the attributes of this plot tool.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
Description:
This function retrieves the number of plot tools of the specified type.
Input:
INTEGER plot_type This value specifies the tool type. If this value is set to
an empty string or , the number of plot tools of all
types is returned. See the remarks below for more
information.
INTEGER status This value specifies the status of the plot tool. Valid
values are: 0 = unposted tools, 1 = posted tools, and 2
= all tools.
Output:
INTEGER <Return Value> This function returns a value specifying the number of
tools of the given type.
Error Conditions:
None.
Remarks:
Example:
Description:
This function retrieves the location and type of data associated with a plot tool.
Input:
STRING plot_type[] This value specifies the tool type. If this value is
set to an empty string or , the location and data
type for all of the plot tools is set. See the remarks
below for more information.
STRING plot_name[] This value specifies the name of the plot tool.
Output:
STRING location[] This value returns the data location.
STRING type[] This value returns the data type.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
Example:
Description:
This function sets the data handling descriptions to the registers for a plot tool which has previously
been posted.
Input:
STRING plot_type[] This value specifies the tool type. If this value is set to
an empty string or , the data associated to all of the
plot tools is set. See the remarks below for more
information.
STRING plot_name[] This value specifies the name of the plot tool.
INTEGER register_id This value specifies the register identifier.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The use of this function will allow subsequent calls to the res_display_fringe_post,
res_display_vector_post, res_display_tensor_post, res_display_deformation_post, and
res_display_graph_post PCL functions to repost the specified plot tool using the data descriptions in the
specified registers.
Example:
None.
1572 PCL Reference Manual
Plot Tool Query Functions
Description:
This function sets the data handling descriptions to the registers for a graph tool which has previously
been posted.
Input:
STRING plot_name[] This value specifies the graph plot tool name.
INTEGER x_register_id This value specifies the register identifier containing
the X axis data.
INTEGER y_register_id This value specifies the register identifier containing
the Y axis data.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
See the Status Messages for information on any error values returned by this function.
Remarks:
The use of this function will allow subsequent calls to the res_display_fringe_post,
res_display_vector_post, res_display_tensor_post, res_display_deformation_post, and
res_display_graph_post PCL functions to repost the specified graphics tool using the data descriptions
in the specified registers.
Example:
None.
Chapter 6: Results Postprocessing Functions 1573
Results Template Functions
Description:
This function creates a result template and states it in the database.
Input:
LOGICAL overwrite_tmpl If TRUE, causes existing template with the same name
and tool type to be overwritten.
STRING name[max 31] Template name.
STRING tool_type[] Template tool type.
STRING desc[VIRTUAL] Template description.
INTEGER num_attributes Number of strings in va_attributes.
STRING va_attributes[113] Template attribute values. Each string consists of up to
(num_attributes) 32 characters of a key value, followed by : and then the
value of up to 80 characters associated with that key.
INTEGER num_options Number of strings in va_options.
STRING va_options[113] Template option values. Each string consists of up to 32
(num_options) characters of a key value, followed by : and then the
value of up to 80 characters associated with that key.
INTEGER num_misc Number of strings in va_misc.
STRING va_misc[113](num_misc) Template miscellaneous values. Each string consists of
up to 32 characters of a key value, followed by : and then
the value of up to 80 characters associated with that key.
STRING pclexp[VIRTUAL] Template Pcl expression. Although a virtual string here,
other parts of the code may limit it to no more than 200
characters.
STRING title[VIRTUAL] Template title. Although a virtual string here, other parts
of the code may limit it to no more than 159 characters.
Output:
INTEGER tmpl_id Internal database id of the newly created template.
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
1574 PCL Reference Manual
Results Template Functions
MSG_RES_RDM_TMPL_INVALID_TYPE
MSG_RES_RDM_INVALID_TOOL_TYPE
MSG_RES_RDM_TOOL_DOES_NOT_EXIST
MSG_RES_RDM_TMPL_NO_NAME
MSG_RES_RDM_TOOL_ALREADY_EXISTS
DbInvalidMemoryDbPageOffset
DbInvalidMemoryDbPageId
Other db errors
DbVirtualMemoryExhausted
Other db exceptions
Remarks
Only the first 31 characters of a result template name are stored in the database.
The valid tool_type values are the valid result tool types. However, at this time, templates are only
supported for Deformation, Fringe, Vector, Tensor, Graph, and Report.
The combination of name and tool_type must be unique.
The deformation attributes:
The array of options values uses the same key words for all the template types. However, note that note
all possible values make sense for a particular tool type or for your particular results data. Take care to
supply appropriate values for your situation.
The data in va_misc is optional and is used to define the color palettes, spectrums, and ranges for result
plots using the template.
If no data is given here, then num_misc should be set to 0. In this case, va_misc needs to be an array of
1 blank string since the code does not support an array of 0 strings, [ ]. This no data case will default
to using the whatever is the current color palette, current spectrum and range as specified in the template
attributes.
Note that not all tools use color palettes, spectrums and ranges. For example, report tools use none of
them while graph tools and deform tools use only the color palette. Data that is not needed by the tool
type will be ignored.
If data is not provided for one or more of the color palette, spectrum or range, then it will default to the
current color palette, current spectrum, and/or range defined by the template attributes.
There are three ways to specify which color palette, spectrum or range to use.
1. You may also explicitly specify to use the current color palette, spectrum and/or range.
2. You may specify the name of an existing color palette or spectrum. This will then be used by the
result tool using the template.
3. You may define the color palette, spectrum and/or range by giving the data that defines them.
Then, when the template is used, a color palette, spectrum and/or range will be created with these
data values and used by the result tool using the template. You have the option to specify that
conflicts with existing color palettes, spectrums and/or ranges in the patran database be
overwritten automatically or that the user be queried about how to resolve the conflict.
Examples of strings to put in the va_misc data array to define spectrums are as follows:
" Spectrum_Use_Current :"
uses the existing spectrum named, or to define a spectrum and overwrite if its name already exists:
"Spectrum_Definition:spectrum_name,Overwrite=TRUE" ,
"Spectrum_Attributes:Continuous=FALSE,Interpolation Factor=2." ,
"Spectrum_LookUpTable:16,[0,1,8,9,3,5,14,15,10,11,2,12,4,13,6,7]"
Examples of strings to put in the va_misc data array to define color palettes are as follows:
" Palette_Use_Current :"
"Palette_Colors:0,[0.,0.,0.]" ,
"Palette_Colors:1,[0.07,0.07,0.07]" ,
"Palette_Colors:2,[0.13,0.13,0.13]" ,
"Palette_Colors:3,[0.2,0.2,0.2]" ,
"Palette_Colors:4,[0.27000001,0.27000001,0.27000001]" ,
"Palette_Colors:5,[0.33000001,0.33000001,0.33000001]" ,
"Palette_Colors:6,[0.40000001,0.40000001,0.40000001]" ,
"Palette_Colors:7,[0.47,0.47,0.47]" ,
"Palette_Colors:8,[0.52999997,0.52999997,0.52999997]" ,
"Palette_Colors:9,[0.60000002,0.60000002,0.60000002]" ,
"Palette_Colors:10,[0.67000002,0.67000002,0.67000002]" ,
"Palette_Colors:11,[0.73000002,0.73000002,0.73000002]" ,
"Palette_Colors:12,[0.80000001,0.80000001,0.80000001]" ,
"Palette_Colors:13,[0.87,0.87,0.87]" ,
"Palette_Colors:14,[0.93000001,0.93000001,0.93000001]" ,
"Palette_Colors:15,[1.,1.,1.]"
Examples of strings to put in the va_misc data array to define ranges are as follows:
" Range_Use_Current :"
use the current range, or to define a range and overwrite if its name already exists:
"Range_Definition:my range,Overwrite=TRUE,NumSubrange=15" ,
"Range_SubRange:0,[8.4472103,4.,6.2236052]" ,
"Range_SubRange:1,[4.,3.8461537,3.9230769]" ,
"Range_SubRange:2,[3.8461537,3.6923075,3.7692306]" ,
"Range_SubRange:3,[3.6923075,3.5384612,3.6153843]" ,
"Range_SubRange:4,[3.5384612,3.3846149,3.4615381]" ,
"Range_SubRange:5,[3.3846149,3.2307687,3.3076918]" ,
"Range_SubRange:6,[3.2307687,3.0769224,3.1538455]" ,
"Range_SubRange:7,[3.0769224,2.9230762,2.9999993]" ,
"Range_SubRange:8,[2.9230762,2.7692299,2.846153]" ,
"Range_SubRange:9,[2.7692299,2.6153836,2.6923068]" ,
"Range_SubRange:10,[2.6153836,2.4615374,2.5384605]" ,
"Range_SubRange:11,[2.4615374,2.3076911,2.3846142]" ,
"Range_SubRange:12,[2.3076911,2.1538448,2.230768]" ,
"Range_SubRange:13,[2.1538448,2.,2.0769217]" ,
"Range_SubRange:14,[2.,1.42274,1.71137]" ]
An example showing definition of spectrum, color palette and range in the result template data is shown
in the example for a fringe template below.
Example - Deformation
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_deform_tmpl" , "Deformation" , @
"My default settings for deformation plots" , @
8 , [ @
"LegendDisplay:ON" , @
"LegendSetting:1" , @
"DeformedStyle:White,Solid,1,Wireframe" , @
"DeformedScale:Model=0.2" , @
"UndeformedStyle:ON,Blue,Solid,1,Wireframe" , @
"TitleDisplay:ON" , @
"MinMaxDisplay:ON" , @
"LabelStyle:Exponential, 12, White, 3" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:" , @
"ScaleFactor:1." , @
"AverageDomain:" , @
"AverageMethod:" , @
"ExtrapolateMethod:AsIs" , @
"SpreadFlag:OFF" , @
Chapter 6: Results Postprocessing Functions 1581
Results Template Functions
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
0 , [ "" ] , @
"" , @
"BENDING, Static Subcase, Displacements, Translational, (NON-LAYERED)" )
Example - Fringe
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_fringe_tmpl " , "Fringe" , @
"My default settings for fringe plots" , @
15 , [ @
"SpectrumDisplay:ON" , @
"LegendDisplay:ON" , @
"LegendSetting:1" , @
"Range:Fri_fri_t" , @
"RangeOverwrite:ON" , @
"RangePost:ON" , @
"FringeStyle:Discrete/Smooth" , @
"Shade:None" , @
"ElemEdge:FreeEdge,Blue,Solid,1" , @
"Shrink:5" , @
"TitleDisplay:ON" , @
"MinMaxDisplay:ON" , @
"ValueDisplay:OFF" , @
"LabelStyle:Exponential, 12, White, 3" , @
"ShowOnDeformed:ON" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:None" , @
"ScaleFactor:1." , @
"AverageDomain:" , @
"AverageMethod:" , @
"ExtrapolateMethod:AsIs" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
36 , [ @
"Spectrum_Definition:std1,Overwrite=TRUE" , @
"Spectrum_Attributes:Continuous=FALSE,Interpolation Factor=2." , @
"Spectrum_LookUpTable:16,[0,1,8,9,3,5,14,15,10,11,2,12,4,13,6,7]" , @
"Palette_Definition:standard_colortable,Overwrite=TRUE,NumColors=16,RGB_HLS=RGB"
, @
"Palette_Colors:0,[0.,0.,0.]" , @
"Palette_Colors:1,[1.,0.,0.]" , @
"Palette_Colors:2,[0.,1.,0.]" , @
"Palette_Colors:3,[1.,1.,0.]" , @
"Palette_Colors:4,[0.,0.,1.]" , @
"Palette_Colors:5,[1.,0.,1.]" , @
"Palette_Colors:6,[0.,1.,1.]" , @
"Palette_Colors:7,[1.,1.,1.]" , @
"Palette_Colors:8,[1.,0.47,0.]" , @
"Palette_Colors:9,[1.,0.80000001,0.]" , @
"Palette_Colors:10,[0.,0.5,0.]" , @
"Palette_Colors:11,[0.,0.75,0.]" , @
"Palette_Colors:12,[0.,0.,0.67000002]" , @
"Palette_Colors:13,[0.,0.60000002,1.]" , @
"Palette_Colors:14,[1.,0.40000001,1.]" , @
"Palette_Colors:15,[1.,0.75,1.]" , @
"Range_Definition:my range,Overwrite=TRUE,NumSubrange=15" , @
"Range_SubRange:0,[8.4472103,4.,6.2236052]" , @
"Range_SubRange:1,[4.,3.8461537,3.9230769]" , @
"Range_SubRange:2,[3.8461537,3.6923075,3.7692306]" , @
"Range_SubRange:3,[3.6923075,3.5384612,3.6153843]" , @
"Range_SubRange:4,[3.5384612,3.3846149,3.4615381]" , @
"Range_SubRange:5,[3.3846149,3.2307687,3.3076918]" , @
1582 PCL Reference Manual
Results Template Functions
"Range_SubRange:6,[3.2307687,3.0769224,3.1538455]" , @
"Range_SubRange:7,[3.0769224,2.9230762,2.9999993]" , @
"Range_SubRange:8,[2.9230762,2.7692299,2.846153]" , @
"Range_SubRange:9,[2.7692299,2.6153836,2.6923068]" , @
"Range_SubRange:10,[2.6153836,2.4615374,2.5384605]" , @
"Range_SubRange:11,[2.4615374,2.3076911,2.3846142]" , @
"Range_SubRange:12,[2.3076911,2.1538448,2.230768]" , @
"Range_SubRange:13,[2.1538448,2.,2.0769217]" , @
"Range_SubRange:14,[2.,1.42274,1.71137]" ] , @
, @
"BENDING, Static Subcase, Displacements, Translational - Magnitude, (NON-
LAYERED)" )
Example - Graph
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_graph_tmpl" , "Graph" , @
"My default settings for graphs" , @
14 , [ @
"curveFitMethod:Linear" , @
"curveStyle:LongDash" , @
"symbolDisplay:OFF" , @
"xAxisLabelDisplay:ON" , @
"xAxisLabel:Displacements, Translational" , @
"xAxisScale:Linear" , @
"xAxisLabelFormat:Exponential, 12, White, 3" , @
"yAxisLabelDisplay:ON" , @
"yAxisLabel:Strain Tensor," , @
"yAxisScale:Linear" , @
"yAxisLabelFormat:Exponential, 12, White, 3" , @
"sortPtsByXCoord:ON" , @
"WindowName:3" , @
"AppendToWindow:OFF" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:" , @
"ScaleFactor:1." , @
"AverageDomain:All" , @
"AverageMethod:DeriveAverage" , @
"ExtrapolateMethod:ShapeFunc" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
0 , [ "" ] , @
"" , @
"Strain Tensor, VONM" )
Example - Report
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_report_tmpl" , "Report" , @
"My default settings for reports" , @
14 , [ @
"ReportType:Full" , @
"ReportTitle:$PRODUCT - Analysis Code: $CODE_NAME " , @
"ReportTitle:Load Case: $LC_NAME, $SC_NAME " , @
"ReportTitle:Result $PRES_NAME, $SRES_NAME - Layer $LYR_NAME " , @
"ReportTitle:Entity: Element Tensor" , @
"ReportHeader:Page $PAGE" , @
"ReportFooter:$DATE" , @
"ReportPage:Height=52,Width=128,TopMargin=5,LeftMargin=8,BottomMargin=5" ,
@
"ReportPagination:OFF" , @
"ReportPageNumber:1" , @
Chapter 6: Results Postprocessing Functions 1583
Results Template Functions
"ReportPageAlignment:Center" , @
"EntitySort:LoadCase" , @
"ValueSort:0,Descending,Algebraic" , @
"ColumnHeaders:ON" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:None" , @
"ScaleFactor:0.5" , @
"AverageDomain:All" , @
"AverageMethod:DeriveAverage" , @
"ExtrapolateMethod:ShapeFunc" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
0 , [ "" ] , @
"" , @
"" )
Example - Tensor
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_tensor_tmpl" , "Tensor" , @
"My default settings for tensor marker plots" , @
20 , [ @
"SpectrumDisplay:ON" , @
"LegendDisplay:ON" , @
"LegendSetting:1" , @
"Range:Ten_ten_t" , @
"RangeOverwrite:ON" , @
"RangePost:ON" , @
"ColoringMethod:Constant" , @
"TensorColors:Blue,Green,Yellow,Red,Magenta,White" , @
"PrincipalColors:Blue,Green,Yellow" , @
"VectorScale:ScreenConstant=0.400000" , @
"HeadStyle:Single" , @
"VectorStyle:Solid" , @
"BoxStyle:ON,Wireframe" , @
"BoxColor:Yellow" , @
"BoxScale:ScreenConstant=0.100000" , @
"TitleDisplay:ON" , @
"MinMaxDisplay:ON" , @
"ValueDisplay:ON" , @
"LabelStyle:Exponential, 12, White, 3" , @
"ShowOnDeformed:ON" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:None" , @
"ScaleFactor:1." , @
"AverageDomain:All" , @
"AverageMethod:DeriveAverage" , @
"ExtrapolateMethod:ShapeFunc" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
0 , [ "" ] , @
"" , @
"BENDING, Static Subcase, Strain Tensor,, (NON-LAYERED)" )
Example - Vector
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_vector_tmpl" , "Vector" , @
"My default settings for vector marker plots" , @
18 , [ @
1584 PCL Reference Manual
Results Template Functions
"SpectrumDisplay:ON" , @
"LegendDisplay:ON" , @
"LegendSetting:1" , @
"Range:Vec_vec_t" , @
"RangeOverwrite:ON" , @
"RangePost:ON" , @
"ColoringMethod:Constant" , @
"VectorColors:Spectrum,Spectrum,Spectrum,Spectrum" , @
"VectorScale:ScreenConstant=0.300000" , @
"VectorAttachment:Head" , @
"HeadStyle:Single" , @
"VectorStyle:Solid" , @
"TailDisplay:ON" , @
"TitleDisplay:ON" , @
"MinMaxDisplay:ON" , @
"ValueDisplay:ON" , @
"LabelStyle:Exponential, 12, White, 3" , @
"ShowOnDeformed:ON" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:Exclude = -1e-36, 1e-36" , @
"ScaleFactor:1." , @
"AverageDomain:" , @
"AverageMethod:" , @
"ExtrapolateMethod:AsIs" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
0 , [ "" ] , @
"" , @
"BENDING, Static Subcase, Displacements, Translational, (NON-LAYERED)" )
Chapter 6: Results Postprocessing Functions 1585
Results Template Functions
Colors Available
Black Red Green Yellow
Blue Magenta Cyan white
Orange LtOrange DkGreen LtGreen
DkBlue LtBlue DkMagenta LtMagenta
Description:
This function modifies an existing results template in the database and replaces its stored values with
the input data values.
Input:
INTEGER tmpl_id Internal database id of the result template record to
modify.
STRING name[max 31] Modified name.
STRING tool_type[] Modified tool type.
STRING desc[VIRTUAL Modified description.
]
INTEGER num_attributes Number of strings in va_attributes.
STRING va_attributes[113](num_attributes)
Modified attribute values. Each string consists of up to 32
characters of a key value, followed by : and then the value
of up to 80 characters associated with that key.
INTEGER num_options Number of strings in va_options.
STRING va_options[113](num_options)
Modified option values. Each string consists of up to 32
characters of a key value, followed by : and then the value
of up to 80 characters associated with that key.
INTEGER num_misc Number of strings in va_misc.
STRING va_misc[113](num_misc)
Modified miscellaneous values. Each string consists of up
to 32 characters of a key value, followed by : and then the
value of up to 80 characters associated with that key.
1586 PCL Reference Manual
Results Template Functions
DbInvalidMemoryDbPageOffset
DbInvalidMemoryDbPageId
Other db errors
DbVirtualMemoryExhausted
Other db exceptions
Remarks:
Only the first 31 characters of a result template name are stored in the database.
The valid tool_type values are the valid result tool types. However, at this time, templates are only
supported for Deformation, Fringe, Vector, Tensor, Graph, and Report.
The combination of name and tool_type must be unique.
Chapter 6: Results Postprocessing Functions 1587
Results Template Functions
Description:
This function deletes the specified results template and its data from the database.
Input:
STRING name[max 31] Name of existing template to be deleted.
STRING tool_type[] The template type.
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
MSG_RES_RDM_TMPL_INVALID_TYPE
MSG_RES_RDM_INVALID_TOOL_TYPE
MSG_RES_RDM_TOOL_DOES_NOT_EXIST
Remarks:
The valid tool_type values are the valid result tool types. However, at this time, templates are only
supported for Deformation, Fringe, Vector, Tensor, Graph, and Report.
Example:
INTEGER status
Status = res_tmpl_delete( my_old_name , Deformation )
1588 PCL Reference Manual
Results Template Functions
Description:
This function creates a new results template in the database and copies the data from an existing
results template in the database to the new one.
Input:
STRING name[max 31] Name for the new template.
STRING existing_name[max 31] Name of existing template to be copied.
STRING tool_type[] The template type.
Output:
INTEGER new_id Internal database id of the newly created template.
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
MSG_RES_RDM_TMPL_INVALID_TYPE
MSG_RES_RDM_INVALID_TOOL_TYPE
MSG_RES_RDM_TOOL_DOES_NOT_EXIST
MSG_RES_RDM_TMPL_NO_NAME
MSG_RES_RDM_TOOL_ALREADY_EXISTS
DbInvalidMemoryDbPageOffset
DbInvalidMemoryDbPageId
Other db errors
DbVirtualMemoryExhausted
Other db exceptions
Remarks:
The valid tool_type values are the valid result tool types. However, at this time, templates are only
supported for Deformation, Fringe, Vector, Tensor, Graph, and Report.
Example:
INTEGER status
Status = res_tmpl_copy( new_id , my_new_name , my_old_name , Deformation )
Chapter 6: Results Postprocessing Functions 1589
Results Template Functions
res_tmpl_set_force_overwrite ( val )
Description:
This function sets or clears a logical value that controls whether existing results templates in the
database are overwritten when importing a template via the res_tmpl_create_over command.
Input:
LOGICAL val TRUE forces overwriting. FALSE has no effect.
Output:
None
Error Conditions:
None
Remarks:
The values is cleared, that is, set to FALSE, whenever a results template form is displayed. Thus, you
will want to issue this command just before the res_tmpl_create_over() command(s) that you want it to
effect there by forcing them to overwrite existing templates. The value is cleared (set to FALSE) when
the forms are displayed to prevent accidental overwriting of templates by the user.
Example:
Res_tmpl_set_force_overwrite_tmpl( TRUE )
1590 PCL Reference Manual
Results Plot Sets
Description:
This function creates a new Plot Set and persists it in the Patran database. An overwrite specifier is
included to allow the command to overwrite an existing Plot Set if it uses the same name as the new
name provided with this command.
Input:
LOGICAL overwrite_plot_set TRUE forces overwriting. FALSE causes the copy to fail
if an existing Plot Set already uses the input new_name.
STRING name[max 79] New Plot Set name.
STRING desc[VIRTUAL] Plot Set description.
Output:
INTEGER plot_set_id Internal database ID of the newly created Plot Set.
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
MSG_RES_PLOT_SET_DOES_NOT_EXIST
DbErrorNotFound
DbOtherFailure
Remarks:
None
Example:
None
Chapter 6: Results Postprocessing Functions 1591
Results Plot Sets
Description:
This function copies an existing Plot Set and persists it in the Patran database. An overwrite specifier
is included to allow the command to overwrite an existing Plot Set if it uses the same name as the new
name provided with this command.
Input:
LOGICAL overwrite_plot_set TRUE forces overwriting. FALSE causes the copy to
fail if an existing Plot Set already uses the input
new_name.
STRING new_name[max 79] New Plot Set name.
STRING new_desc[VIRTUAL] Plot Set description.
INTEGER old_id Internal database id of the Plot Set to be copied.
STRING old_name[max 79] Plot Set name to be copied.
Output:
INTEGER new_id Internal database ID of the newly created Plot Set.
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
MSG_RES_PLOT_SET_DOES_NOT_EXIST
MSG_RES_PLOT_SET_LONG_NAME
MSG_RES_PLOT_SET_NULL_NAME
MSG_RES_PLOT_SET_EMPTY_NAME
MSG_RES_PLOT_SET_BLANK_NAME
MSG_RES_PLOT_INVALID_NAME
DbErrorNotFound
DbOtherFailure
DbNotADatabase
DbOutOfMemory
Remarks:
If old_name is not blank it will be used to look up the existing Plot Set and the old_id will be ignored.
Otherwise, old_id will be used to lookup the existing Plot Set in the database.
1592 PCL Reference Manual
Results Plot Sets
Example:
None.
Description:
This function creates a plots sets row definition.
Input:
STRING plot_set_name[max 79] Plot Set name the row is associated to.
INTEGER row_index Position of row within the Plot Set definition.
STRING row_type_name[ ] Specification of the rows purpose. The options are:
Fringe Plot, Deformed Plot, Vector Plot,
Tensor Plot, Image Data, Default Values,
Column Order, Combined Plot, and Saved Plot.
INTEGER num_cols Number of data column sets that are required to
support the row type.
STRING a_col_vals Data required to support the row type. Each data
column must have the following data within the
column: column_type_name, num_values, value1,
value2, ..., valueN.
INTEGER stride The stride specifies how column data must be indexed.
If the stride value is less than or equal to 0 then data
indexing is assumed to be num_values + 2 strings. If
stride is greater than 0 then the stride value represents
the index jump size. This allows the data to be given
in a two dimensional array. In this case stride is the
size of the first dimension. It should be at least the
largest of the num_values +2. The second dimension
should be at least the number of columns in the row.
Output:
INTEGER row_id Internal database ID of the newly created Plot Set row.
INTEGER <Return Value> Zero for success, else error message code.
Chapter 6: Results Postprocessing Functions 1593
Results Plot Sets
Error Conditions:
MSG_RES_PLOT_SET_DOES_NOT_EXIST
MSG_RES_PLOT_SET_LONG_NAME
MSG_RES_PLOT_INVALID_NAME
MSG_RES_PLOT_SET_NULL_NAME
MSG_RES_PLOT_SET_EMPTY_NAME
MSG_RES_PLOT_SET_BLANK_NAME
DbInstanceNotFound
DbOutOfMemory
DbNotADatabase
DbOtherFailure
Remarks:
a_col_vals is either a one dimensional array with data packed sequentially (stride <= 0) or the equivalent
of a two dimensional array dimensioned (num_cols)(stride).
Example:
None
Iterator Descriptions
When you define your Plot Set rows with the, res_create_plot_set_row, command you must provide one
or more a_col_vals which represents the data required to support the row type. The syntax for
a_col_vals is, column_type_name, num_values, value1, value2, ..., valueN. If you specify num_values
greater than 1and provide the corresponding number of data values the Plot Set system iterate across
these values to produce the Plot Sets analysis plots. Currently there are two iteration methods available.
They are, outer product iterator, abbreviated product and tuple iterator, abbreviated tuple.
At the top of the example Plot Set you will see the following PCL declarations for the variables used in
the file. As you can see the plot names are limited to 79 characters.
INTEGER plot_set_id, status
INTEGER row_id
STRING plot_set_name [ 79 ]
At the start of each Plot Set definition you must specify the Plot Set name and call the function that
creates the new Plot Set within Patrans database.
plot_set_name = "combo_plot_1"
status = res_plot_set_create_over( plot_set_id , FALSE ,
plot_set_name , @
"Deformed fringe plot" )
IF( status == 0 ) THEN
<lines that represent the Plot Set definition go here>
END IF
If the create function returns a successful status then, as we will describe in the next point, the Plot Set
row definitions will be exercised to provide the content of the Plot Set definition.
The arguments of the res_plot_set_create_over function are as follows.
plot_set_id An output variable the returns the id of the new Plot Set.
FALSE (or TRUE) A logical that specifies if the command is allowed to over write an existing
Plot Set definition if the Plot Set names are identical. (TRUE = over write
allowed)
plot_set_name The new Plot Set name to be created.
Deformed fringe plot The Plot Sets text description.
Within this samples Plot Sets IF-block are placed res_create_plot_set_row commands. These commands
provide the combination plots specification and the fringe and deform plots that define the combo plot.
Described below are the rows specifying the combination plot and its fringe plot. The specification for
the deformed plot is similar to the fringe plot and therefore will not be described.
The arguments of res_create_plot_set_row function for the combination plot specification are as follows.
row_id Output variable that returns the id of the new Plot Set row.
plot_set_name The Plot Set name that the row belongs to.
1 The row index within the Plot Set.
Combined Plot The row type. Options are, Fringe Plot, Deformed Plot, Vector Plot,
Tensor Plot, Image Data, Default Values, Column Order,
Combined Plot, and Saved Plot.
3 The number of data columns that are needed to support the row type.
1596 PCL Reference Manual
Results Plot Sets
Combined Plot Data The data column syntax is defined to be, column_type_name, num_values,
Columns: value1, value2, ..., valueN. Appendix B shows the data necessary to
support the various row types.
Num Combo Plots / Num Combo Rows / Iterator Type
These are the column_type_name selection for the combo plot row
columns. They must be used in the order shown.
1 Number of data specifications to follow.
2 / 2 / product The first value represents the number of plots that define the combination
plot. The second value represents the number of total rows that are used to
define the combination plot. The number of plots and the number of rows
might be different since extra rows can be interspersed between the plot
definition rows to alter global parameters that effect all plot types. In the
first release, interspersed rows are not supported and the number of plots
and rows should be the same. The final value, product, represents the
iterator type used to generate the combined plots. Iterator types are
described in detail in Appendix B.
0 The stride specifies how column data must be indexed. If the stride value
is less than or equal to 0 then data indexing is assumed to be num_values
+ 2 strings. If stride is greater than 0 then the stride value represents the
index jump size. This allows the data to be given in a two dimensional
array. In this case stride is the size of the first dimension. It should be at
least the largest of the num_values +2. The second dimension should be at
least the number of columns in the row.
The arguments of res_create_plot_set_row for the fringe plot specification are as follows.
row_id Output variable that returns the id of the new Plot Set row.
plot_set_name The Plot Set name the row belongs to.
2 The row index within the Plot Set.
Fringe Plot The row type. Options are, Fringe Plot, Deformed Plot, Vector Plot,
Tensor Plot, Image Data, Default Values, Column Order,
Combined Plot, and Saved Plot.
14 The number of data columns that are needed to support the row type.
Fringe Plot Data The data column syntax is defined to be, column_type_name, num_values,
Columns: value1, value2,..., valueN. Since these are labeled data entries they can be
entered in any order. Appendix B shows the data necessary to support the
various row types.
Loadcase Column specification used to identify the analysis results data set.
1 Number of load cases.
Combine Load case name.
Subcase Column specification used to identify the analysis results data set.
Chapter 6: Results Postprocessing Functions 1597
Results Plot Sets
1 Number of subcases.
Subcase 3 Subcase name. Used to identify the analysis results data.
Primary Result Column specification used to identify the primary results type name.
1 Number of primary results types.
Nodal Vector Primary specification of results to be rendered. Typical options are,
Displacement, Stress, Strain, Constraint Forces, Strain Energy,
etc.
Secondary Result Column specification used to identify the secondary results type name.
1 Number of secondary results types.
Demo Result1 Secondary specification of results to be rendered. Typical options are,
Translational, , Energy, Moment Resultant, Energy Density,
etc.
Layer Location Column specification used to identify the data layer location.
1 Number of layer ids specified for the plot.
Nonlayered data. Typical options are, Z2, Layer 1, At Middle, etc.
Derived Quantity Column specification used to identify the derivation to be applied to the
analysis data.
1 Number of derivations specified.
ZZ Extract the ZZ component. Typical options are, von Mises, tresca,
Min Principal, Magnitude, etc.
Target Column specification used to identify the of entities to render the plot
upon.
1 Number of target specifications.
FreeFaces,0 Render on the nodes posted in the view port that lie on the elements free
faces. Typical options are, Elements,0, Nodes,0, etc.
Template Column specification used to identify the associated plot template that is
to be retrieved to provide the plots graphics attributes and numerical
operation options.
1 Number of templates that are specified.
fringe_template Template name to retrieve.
Save As Column specification used to allow the plot to be persisted with a name
1 Number of plot names specified
Blank specifier implies the default name will be used (e.g. default_Fringe).
filename Column specification used to allow the user to provide a print file name for
the plot.
1 Number of print file names that are provided
1598 PCL Reference Manual
Results Plot Sets
If left blank as it is here the Plot Set name will be used as the default print
file name.
Title Column specification that allows user to enter a plot title.
1 Number of title specifiers
Since a blank title has been specified the title that is specified in the
template file will be used. Titles are limited to 159 characters.
Range Column specification of the range name that will be used for the plot.
1 Number of range specifiers
Since a blank range name has been specified the plot will use the range
tools default range (e.g. Fri_default_Fringe, Vec_default_Vector, etc.).
Spectrum Specification of the spectrum name that will be used for the plot.
1 Number of spectrum specifiers
Since a blank spectrum name has been specified the plot will use the
default spectrum (i.e. standard_spectrum).
Viewport Column specification of the viewport the plot will be rendered within.
1 Number of viewport specifiers
Since a blank viewport name has been specified the plot will be rendered
in the current viewport.
Chapter 6: Results Postprocessing Functions 1599
Results Plot Sets
"fringe_template" , @
"Save As" , "1" , @
"" , @
"Filename" , "1" , @
"" , @
"Title" , "1" , @
"" , @
"Range" , "1" , @
"" , @
"Spectrum" , "1" , @
"" , @
"Viewport" , "1" , @
"" ] , 0 )
res_create_plot_set_row( row_id , plot_set_name , 3 , @
"Deformed Plot" , 14 , @
[ "Loadcase" , "1" , @
"Derived Results" , @
"Subcase" , "2" , @
"Demo" , @
"DemoElem" , @
"Primary Result" , "1" , @
"Nodal Vector" , @
"Secondary Result" , "1" , @
"Demo Result1" , @
"Layer Location" , "1" , @
"" , @
"Show As" , "4" , @
"Resultant,x" , @
"Component,on,off,off" , @
"Component,off,on,off" , @
"Component,off,off,on" , @
"Target" , "2" , @
"Elements,0," , @
"Nodes,0," , @
Chapter 6: Results Postprocessing Functions 1601
Results Plot Sets
"Template" , "1" , @
"def_tmpl" , @
"Save As" , "1" , @
"" , @
"Filename" , "1" , @
"" , @
"Title" , "2" , @
"$Use_Default_Title" , @
Description:
Update a plot set Combined Plot row.
Input:
STRING set_name[] Plot Set name.
STRING row_name[] Row name.
STRING iterator_type[] Type of iterator, "Tuple" or "Product"
INTEGER num_rows Number of "active" rows defining Combo Plot
INTEGER total_rows Number of all rows defining Combo Plot
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
None
1602 PCL Reference Manual
Results Plot Sets
Description:
Update a plot set row with results data.
Input:
STRING set_name[] Plot Set name.
STRING row_name[] Row name.
STRING row_type[] Type of row, eg, "Fringe Plot"
STRING result_type[] Type of result, eg "Nodal Vector"
STRING result_cases[]() Result cases
STRING results[]() Results
STRING derived_quantities[]() Derived Quantities
STRING show_as[]() Show as selections
STRING layers[]() Layers
STRING rescase_combinations[]() Result case combination methods
STRING layer_combinations[]() Layer combination methods
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
update_plotset_results_data( "Combined_Fringe_Plots",
"Fringe_Plots", @
"Fringe Plot", "Element Tensor", ["SKRUVAD INF|STNING, Static
Subcase", @
"SKRUVAD INF|STNING-REVERSED, Static Subcase"], ["Stress
Tensor"], [ @
"Von Mises", "X Component", "Y Component", "Max Principal"],
[""], ["At Z1"], @
["NONE"], ["NONE"] )
Chapter 6: Results Postprocessing Functions 1603
Results Plot Sets
Description:
Update a plot set row with Attributes data.
Input:
STRING set_name[] Plot set name
STRING row_name[] Row name
STRING templates[]() Result templates
STRING viewports[]() Viewports
STRING views[]() Views
STRING spectrums[]() Spectrums name
STRING ranges[]() Ranges
STRING tool_name[] Tool name
STRING print_fname[] Print filename
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
update_plotset_attributes_data( "Combined_Fringe_Plots", "Fringe_Plots", [ @
"Fringe_attribue_1", "Fringe_attribue_2"], ["default_viewport"], [ @
"isometric_view"], ["standard_spectrum"], ["standard_range"], "", "" )
1604 PCL Reference Manual
Results Plot Sets
Description:
Update a plot set row with Targets data.
Input:
STRING set_name[] Plot set name
STRING row_name[] Row name
STRING targets[]() Target sets
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
update_plotset_targets_data( "Combined_Fringe_Plots",
"Fringe_Plots", [ @
"Current Viewport;Free Faces", "Elements;Free Faces;Elm 1:33
37:39 42:44 8" // @
"6 89 90 93 94 135:169 171:178 222 223 226 227 268:291 293:296
298:300 302" // @
":318 320:468 471:477 479 490:495 498 499 514:789 832 834
873:877:2 881 88" // @
"2 885:890 893:898 900:931 959:965:2 966:970 1007:1015:2
1016:1022 1059 10" // @
"63:1067:2 1068:1074 1102 1108:1117 1120:1125 1128:1133
1136:1141 1143:116" // @
"9 1203:1208 1245 1247 1253:1259 1261:1332 1341:1344 1351:1477"]
)
Chapter 6: Results Postprocessing Functions 1605
Results Plot Sets
Description:
Update a plot set row with image_data data.
Input:
STRING set_name[] Plot set name
STRING row_name[] Row name
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
Remarks:
None
Example:
None
Description:
Rename a plotset and/or change the description.
Input:
STRING set_name[] Plot set name
STRING new_set_name[] New Plot Set Name
STRING row_name[] Plot Set description
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
1606 PCL Reference Manual
Results Plot Sets
Example:
None
Description:
Add a plotset row to the end of a plotset.
Input:
STRING set_name[] Plot set name
STRING new_row_name[] New Row Name
STRING row_type[] Row Type
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
None
Chapter 6: Results Postprocessing Functions 1607
Results Plot Sets
Description:
Insert a plotset row in a plotset.
Input:
STRING set_name[] Plot Set Name
STRING new_row_nam New Row Name
e[]
STRING row_type[] Row Type
STRING position[] Position, "Before","After","Beginning","End" or ""
STRING target_row[] Row Name to target Ignored if position is not
"Before" or "After" Need more comments on
optional args, etc.
Output:
INTEGER <Return Zero for success, else error message code.
Value>
Error Conditions:
See Error conditions:, 1613 for more information.
Remarks:
None
Example:
None
1608 PCL Reference Manual
Results Plot Sets
Description:
Insert a plotset row in a plotset.
Input:
STRING set_name[] Plot Set Name
STRING source_row[] Row name to Rename
STRING new_row_name[] New Row Name Stays the same if blank
STRING row_type[] Row Type Stays the same if blank
STRING target_row[] Row Name to target Ignored if position is not "Before" or
"After" Need more comments on optional args, etc.
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
None
Chapter 6: Results Postprocessing Functions 1609
Results Plot Sets
Description:
Move a plot set row within a plot set.
Input:
STRING set_name[] Plot Set Name
STRING source_row[] Row name to Move
STRING position[] Position, "Before", "After","Beginning", "End", "" "Up",
"Down"
STRING target_row[] Row Name to target Ignored if position is not "Before" or
"After"
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
None
1610 PCL Reference Manual
Results Plot Sets
Description:
Move a plot set row within a plot set.
Input:
STRING set_name[] Plot Set Name
STRING source_rows[] Row name to Move
STRING position[] Position, "Before", "After","Beginning", "End", "" "Up",
"Down"
STRING target_row[] Row Name to target Ignored if position is not "Before" or
"After"
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
None
Chapter 6: Results Postprocessing Functions 1611
Results Plot Sets
Description:
Copy a plotset row within a plotset.
Input:
STRING set_name[] Plot Set Name
STRING source_row[] Row name to copy
STRING new_row_name[] New row name
STRING position[] Position, "Before", "After","Beginning", "End", "" "Up",
"Down"
STRING target_row[] Row Name to target Ignored if position is not "Before" or
"After"
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
None
1612 PCL Reference Manual
Results Plot Sets
Description:
Delete a plotset row from a plotset.
Input:
STRING set_name[] Plot Set Name
STRING source_row[] Row name to delete
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
None
Description:
Delete plotset rows from a plotset.
Input:
STRING set_name[] Plot Set Name
STRING source_rows[] Row name to delete
Output:
INTEGER <Return Value> Zero for success, else error message code.
Error Conditions:
See Error conditions: for more information.
Remarks:
None
Example:
None
Chapter 6: Results Postprocessing Functions 1613
Results Plot Sets
Error conditions:
#define PLOTSET_UNEXPECTED_ERROR 1001
#define PLOTSET_DOES_NOT_EXIST 1002
#define PLOTSET_ROW_DOES_NOT_EXIST 1003
#define PLOTSET_ROW_INDEX_NOT_EXIST 1004
#define PLOTSET_ID_DOES_NOT_EXIST 1005
#define PLOTSET_ROW_STORE_FAILED 1006
#define PLOTSET_BAD_ROW_TYPE 1007
#define PLOTSET_BAD_RESULT_TYPE 1008
#define PLOTSET_SINGLE_STRING 1009
#define PLOTSET_BAD_ROW_TYPE_NAME 1010
#define PLOTSET_BAD_ROW_TYPE_ID 1011
#define PLOTSET_BAD_COL_TYPE_ID 1012
#define PLOTSET_ROW_UNEXPECTED_ERR 1013
#define PLOTSET_ROW_NEEDS_AT_LEAST_ONE 1014
#define PLOTSET_ROW_NO_DOUBLE_COMBOS 1015
#define PLOTSET_BAD_RESULTS_ROW_TYPE 1016
#define PLOTSET_UNKNOWN_RESULT_TYPE 1017
#define PLOTSET_UNSPECIFIED_RESULT_TYPE 1018
#define PLOTSET_BAD_ROW_ACTION 1019
#define PLOTSET_DUPLICATE_ROW_NAME 1020
#define PLOTSET_BLANK_ROW_NAME 1021
#define PLOTSET_ROW_DOESNT_EXIST 1022
#define PLOTSET_BAD_ROW_POSITION 1023
#define PLOTSET_TARGET_ROW_DOESNT_EXIST 1024
#define PLOTSET_TARGET_ROW_IS_BLANK 1025
#define PLOTSET_ROW_CHANGING_TYPES 1026
#define PLOTSET_ROW_IGNORED 1027
#define PLOTSET_ROW_NOTHING_TO_DELETE 1028
#define PLOTSET_REPEATED_ROW_NAME 1029
#define PLOTSET_NAME_IS_BLANK 1030
#define PLOTSET_ALREADY_EXISTS 1031
#define PLOTSET_ROW_NAME_DOES_NOT_EXIST 1032
#define PLOTSET_APPEND_ERROR 1033
#define PLOTSET_BAD_COMBO_ROW_TYPE 1034
#define PLOTSET_BAD_COMBO_ITERATOR 1035
#define PLOTSET_BAD_COL_TYPE_NAME 1036
#define PLOTSET_WRONG_COLUMN_COUNT 1037
#define PLOTSET_WRONG_COLUMN_TYPE 1038
#define PLOTSET_BAD_ITERATOR_TYPE 1039
#define PLOTSET_BAD_TEMPLATE_FOR_ROW 1040
#define PLOTSET_BAD_TARGET 1041
#define PLOTSET_BAD_TARGET2 1042
#define PLOTSET_NO_ATTRIBUTES 1043
#define PLOTSET_NO_TARGETS 1044
#define PLOTSET_BAD_PRINT_FNAME 1045
1614 PCL Reference Manual
Results Plot Sets
Chapter 7: XY Plot Functions
PCL Reference Manual
7 XY Plot Functions
Introduction 1616
Create Action 1617
Post Action 1635
Modify Action 1643
Rename Action 1746
Delete Action 1747
1616 PCL Reference Manual
Introduction
Introduction
This chapter documents the functions that are used in the implementation of the XY Plot switch bar
form.
This chapter presents function descriptions in five separate sections:
Create Action This section is used to describe some of the functions used to implement the
Create actions.
Post Action This section is used to describe some of the functions used to implement the
Post actions.
Modify Action This section is used to describe some of the functions used to implement the
Modify actions.
Rename Action This section is used to describe some of the functions used to implement the
Rename actions.
Delete Action This section is used to describe some of the functions used to implement the
Delete action.
Chapter 7: XY Plot Functions 1617
Create Action
Create Action
This section is used to describe some of the functions used to implement the Create actions.
Description:
This function creates a curve.
Input:
STRING curve_name[31] This value specifies the name of the curve to create.
STRING text[31] This value specifies the text for this curve.
INTEGER text_color This value specifies what color index to use for the text.
See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000008 The specified new title name already exists. Please check the listbox of current title
names and re-input your title name.
10000009 The specified text is invalid. Please input a valid text string.
10000010 The color index has returned an invalid value.
10000102 The specified curve name is invalid.
10000104 A current curve has not been defined.
10000105 The specified curve name already exists. Please check the listbox of current curves
and re-input your curve name.
10000703 The specified window name already exists.
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
13000067 XY curve not found
1618 PCL Reference Manual
Create Action
Remarks:
Example:
xy_curve_current_get (curve_name)
Description:
This function gets the current curve.
Input:
None.
Output:
STRING curve_name[31] This value returns the curve name.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000063 XY window not found
Example:
xy_curve_current_set (curve_name)
Description:
This function sets the current curve.
Input:
STRING curve_name[31] This value specifies the curve name to make current.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000102 The specified curve name is invalid.
13000067 XY curve not found
Example:
Description:
This function reads x and y data value sets representing curve data from a file, starting at a specific
data set.
Input:
STRING file_name[] This value specifies the name of the file to read from.
STRING curve_name[31] This value specifies the curve name.
INTEGER set_number This value specifies the data set defining the starting
point at which data will be read from the file. The file
contains ascii data defining sets of X and Y data values.
The first character of each line of text in the file is either
the case insensitive character X or Y followed by a real
number representing the data. Each X and Y data point
together forms a set of data points.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
20002 String specified is too small
8103001 File Already Exists
8103002 File Not Found
8103003 Maximum File Version Exceeded
8103011 File not executable
8105001 No memory to allocate text I/O channel
8105009 Text I/O channel table full
10000011 No memory available for current XY operation.
10000014 The requested dataset is not found in the curve data file
10000102 The specified curve name is invalid.
10000104 A current curve has not been defined.
10000706 The .xyd data file has an invalid header line. The line must look like either
XYDATA,curvename or YDATA,curvename.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Chapter 7: XY Plot Functions 1621
Create Action
Example:
Description:
This function gets curve data. It should be used in conjunction with
xy_curve_num_points_get to determine the allocation size of the x and y point arrays.
Input:
STRING curve_name[31] This value specifies the curve name to get the
curve data for.
Output:
LOGICAL yonly This value returns a logical which indicates
whether XY, when set to FALSE, or Y data,
when set to TRUE, was returned.
INTEGER npoints This value returns the number of points
returned.
REAL x_array(VIRTUAL) This value returns an array of x data points.
Must be allocated before use.
REAL y_array(VIRTUAL) This value returns an array of y data points.
Must be allocated before use.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function gets the number of curve data points.
Input:
STRING curve_name[31] This value specifies the curve name to get the curve
data for.
Output:
LOGICAL yonly This value returns a logical which indicates whether
XY, when set to FALSE, or Y data, when set to TRUE,
was returned.
INTEGER npoints This value returns the number of points returned.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function creates curves with data point values.
Input:
STRING curve_name[31] This value specifies the curve name which is to have
data point values assigned to it.
LOGICAL yonly This value specifies, when set to TRUE, that only the
information in the input value y_array is to be used. If
this value is set to FALSE, both the input values
x_array and y_array will be used.
INTEGER npoints This value specifies the number of points to set.
REAL x_array(npoints) This value specifies an array of x data points.
REAL y_array(npoints) This value specifies an array of y data points.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000011 No memory available for current XY operation.
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
xy_curve_list_get (curve_list)
Description:
This function gets the list of curves.
Input:
None.
Output:
STRING curve_list[31]() This value returns a list of curves from the database. This array
must be allocated with enough offsets to contain the entire list.
Use the function xy_curve_num_get() to get the number of
offsets required.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
10000011 No memory available for current XY operation.
13000067 XY curve not found
Example:
xy_curve_num_get (ncurves)
Description:
This function gets the number of curves in the database.
Input:
None.
Output:
INTEGER ncurves This value returns the number of curves found in the
database.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
None.
Chapter 7: XY Plot Functions 1625
Create Action
Example:
Description:
This function creates a title.
Input:
STRING title_name[256] This value specifies the name of title to be created.
STRING text[256] This value specifies the text for this title.
INTEGER font_size This value specifies the font size of the text.
REAL location(2) This value specifies the location where the text is to be
placed. Offset 1 will specify the X location and offset
2 will specify the Y location. These values can range
from 1.0 to 100.0.
INTEGER text_color This value specifies what color index to use for the
text. See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000005 The specified XY title name is invalid. Please Input a valid title name that is
31 characters or less and contains no embedded blanks.
10000006 The XY font name typed in is invalid. Please input a valid font name.
10000007 The X and Y location must both be in %. This is a percentage of the XY
window from the top left corner. Please input valid X and Y locations.
10000009 The specified text is invalid. Please input a valid text string.
10000010 The color index has returned an invalid value.
10000101 The specified title does not exist in the database.
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
13000068 XY title not found
Remarks:
1626 PCL Reference Manual
Create Action
Example:
Please see xy_title_create (p. 1151) in the PCL Reference Manual Examples.
xy_title_list_get (title_list)
Description:
This function gets the list of titles.
Input:
None.
Output:
STRING title_list[256]() This value returns a list of titles from the database. This
array must be allocated with enough offsets to contain
the entire list. Use the function xy_title_num_get() to get
the number of offsets required.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Example:
xy_title_num_get (ntitles)
Description:
This function gets the number of titles in the database.
Input:
None.
Output:
INTEGER ntitles This value returns the number of titles found in the
database.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Example:
Description:
This function creates a xy window.
Input:
STRING window_name[31] This value specifies the name of the window to create.
REAL x_location This value specifies the X location for the window. This
value must be greater than 0.
REAL y_location This value specifies the Y location for the window. This
value must be greater than 0.
REAL width This value specifies the width of the window. This
value must be greater than 0.
REAL height This value specifies the height of the window. This
value must be greater than 0.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000007 The X and Y location must both be in %. This is a percentage of the XY window
from the top left corner. Please input valid X and Y locations.
10000700 The specified window name is invalid. Enter a window name that is less than
31 characters and that has no embedded blanks.
10000702 The specified window height is invalid.
13000004 Duplicate entry exists in table
13000063 XY window not found
13000214 No corresponding message available
Example:
xy_window_current_get (window_name)
Description:
This function gets the current xy window.
Input:
None.
Output:
STRING window_name[31] This value returns the xy window name.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
13000063 XY window not found
Example:
xy_window_current_set (window_name)
Description:
This function sets the current window.
Input:
STRING window_name[31] This value specifies the window name to make current.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000700 The specified window name is invalid. Enter a window name that is less than
31 characters and that has no embedded blanks.
13000063 XY window not found
Example:
xy_window_list_get (window_list)
Description:
This function gets the list of xy windows.
Input:
None.
Output:
STRING window_list[31]() This value returns a list of xy windows from the
database. This array must be allocated with enough
offsets to contain the entire list. Use the function
xy_window_num_get() to get the number of offsets
required.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000011 No memory available for current XY operation.
13000063 XY window not found
Example:
xy_window_nposted_get (nposted)
Description:
This function gets the number of posted xy windows in the database.
Input:
None.
Output:
INTEGER nposted This value returns the number of posted xy windows
found in the database.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
None.
Example:
xy_window_num_get (nwindows)
Description:
This function gets the number of xy windows in the database.
Input:
None.
Output:
INTEGER nwindows This value returns the number of xy windows found in the
database.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Example:
xy_window_post (window_name)
Description:
This function posts a xy window.
Input:
STRING window_name[31] This value specifies the name of the xy window to
post.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000011 No memory available for current XY operation.
10000705 There is no current window specified.
13000063 XY window not found
Example:
xy_window_posted_get (posted_list)
Description:
This function gets the list of posted xy windows.
Input:
None.
Output:
STRING posted_list[31]() This value returns a list of posted xy windows from
the database. This array must be allocated with
enough offsets to contain the entire list. Use the
function xy_window_nposted_get() to get the number
of offsets required.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000011 No memory available for current XY operation.
13000063 XY window not found
Example:
xy_window_unpost (window_name)
Description:
This function unposts a xy window.
Input:
STRING window_name[31] This value specifies the name of the xy window to unpost.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000705 There is no current window specified.
13000063 XY window not found
Example:
Description:
This function is used to write XY curve data to a file.
Input:
STRING curve_name[256] The name of the curve whose data is to be written.
STRING title[256] The title of the curve.
STRING filename[256] The name of the file to write.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Example:
None.
Chapter 7: XY Plot Functions 1635
Post Action
Post Action
This section is used to describe some of the functions used to implement the Post actions.
xy_curve_nposted_get (nposted)
Description:
This function gets the number of posted curves in the database.
Input:
None.
Output:
INTEGER nposted This value returns the number of posted curves found in the
database.
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
13000063 XY window not found
Example:
xy_curve_posted_get (posted_list)
Description:
This function gets the list of posted curves.
Input:
None.
Output:
STRING posted_list[31]( This value returns a list of posted curves from the database.
) This array must be allocated with enough offsets to contain
the entire list. Use the function xy_curve_nposted_get() to
get the number of offsets required.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000011 No memory available for current XY operation.
13000063 XY window not found
13000067 XY curve not found
Example:
xy_title_nposted_get (nposted)
Description:
This function gets the number of posted titles in the database.
Input:
None.
Output:
INTEGER nposted This value returns the number of posted titles found in
the database.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000063 XY window not found
Example:
xy_title_posted_get (posted_list)
Description:
This function gets the list of posted titles.
Input:
None.
Output:
STRING posted_list[256]() This value returns a list of posted titles from the
database. This array must be allocated with enough
offsets to contain the entire list. Use the function
xy_title_nposted_get() to get the number of offsets
required.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000011 No memory available for current XY operation.
13000063 XY window not found
13000068 XY title not found
Example:
Description:
This function posts a curve to the window.
Input:
STRING window_name[31] This value specifies the name of the window to which
the curve will be posted.
STRING curve_name[31] This value specifies the name of the curve that is to be
posted to the window,
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000008 The specified new title name already exists. Please check the listbox of
current title names and re-input your title name.
10000104 A current curve has not been defined.
10000105 The specified curve name already exists. Please check the listbox of current
curves and re-input your curve name.
10000703 The specified window name already exists.
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
13000067 XY curve not found
Example:
Description:
This function unposts a curve to the window.
Input:
STRING window_name[31] This value specifies the name of the window to be
created.
STRING curve_name[31] This value specifies the name of the curve that is to
be unposted from the window,
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
10000705 There is no current window specified.
13000063 XY window not found
13000067 XY curve not found
Example:
Description:
This function posts a title to the window.
Input:
STRING window_name[31] This value specifies the name of the window to which
the title will be posted.
STRING title_name[256] This value specifies the name of the title that is to be
posted to the window.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000101 The specified title does not exist in the database.
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
13000068 XY title not found
Example:
Description:
This function unposts a title to the window.
Input:
STRING window_name[31] This value specifies the name of the window from
which the title will be unposted.
STRING title_name[256] This value specifies the name of the title that is to be
unposted from the window.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000101 The specified title does not exist in the database.
10000705 There is no current window specified.
13000063 XY window not found
13000068 XY title not found
Example:
Modify Action
This section is used to describe some of the functions used to implement the Modify actions.
Description:
This function gets the labels assignment method.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
STRING method[20] This value returns the labels assignment method for
the specified axis. This value can return
automatic, manual, semiauto, and range.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the labels assignment method.
Input:
STRING axis_name[31] This value specifies the axis name.
STRING method[20] This value specifies the label assignment method to be
used for the specified axis. This value can be set to
automatic, manual, semiauto, and range.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
10000307 The specified assignment method for the axis is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the axis color index.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
INTEGER color_index This value returns the color index for the specified axis.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the axis color index.
Input:
STRING axis_name[31] This value specifies the axis name.
INTEGER color_index This value specifies the color index for the specified
axis. See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000010 The color index has returned an invalid value.
10000302 A current axis has not been defined.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Remarks:
Example:
Description:
This function gets the display labels flag.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
LOGICAL label_flag This value returns the display labels flag.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the display labels flag.
Input:
STRING axis_name[31] This value specifies the axis name.
LOGICAL label_flag This value specifies the display labels flag.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
10000305 The specified axis display flag is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the display title flag.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
LOGICAL title_flag This value returns the display title flag.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the display title flag.
Input:
STRING axis_name[31] This value specifies the axis name.
LOGICAL title_flag This value specifies the display title flag.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the grid display type.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
STRING grid_type[31] This value returns the grid display type for the
specified axis. The following values can be
returned: Primary, Secondary,
PrimarySecondary, Both, or None.
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the grid display type.
Input:
STRING axis_name[31] This value specifies the axis name.
STRING grid_type[31] This value specifies the grid display type for the
specified axis. This value can be set to Primary,
Secondary, PrimarySecondary, Both, or
None.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
10000500 The specified display type for grid lines is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the grid line attributes.
Input:
STRING axis_name[31] This value specifies the axis name.
STRING prim_sec[31] This value specifies the primary or secondary grid line. This
value can be set to Primary, Secondary,
PrimarySecondary, or Both.
Output:
STRING curve_style[31] This value returns the grid line curve style. This value can
return Solid, Dotted, DotDash, ShortDash,
LongDash, or OddDash.
INTEGER thickness This value returns the grid line thickness.
INTEGER color_index This value returns the grid line color.
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the grid line attributes.
Input:
STRING axis_name[31] This value specifies the axis name.
STRING prim_sec[31] This value specifies the primary or secondary grid line. This
value can be set to Primary, Secondary,
PrimarySecondary, or Both.
STRING curve_style[31] This value specifies the grid line curve style. This value can be
set to: Solid, Dotted, DotDash, ShortDash,
LongDash, or OddDash.
INTEGER thickness This value specifies the grid line thickness. This value must be
greater than 0 and less than 51.
INTEGER color_index This value specifies the grid line color. See the remarks below
for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
10000010 The color index has returned an invalid value.
10000013 Invalid option given to XY routine.
10000201 The specified line style is invalid. Please choose another from the option menu.
10000302 A current axis has not been defined.
10000501 The specified thickness for grid lines is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Remarks:
Example:
Description:
This function gets the label color index.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
INTEGER label_color This value returns the label color index for the specified
axis.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the label color index.
Input:
STRING axis_name[31] This value specifies the axis name
INTEGER label_color This value specifies the label color index for the
specified axis. See the remarks below for more
information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000010 The color index has returned an invalid value.
10000302 A current axis has not been defined.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Remarks:
Example:
Description:
This function gets the label format value. (float, exponential, integer, power).
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
STRING label_format[31] This value returns the label format for the specified axis.
This value can return Fixed, Exponential, Integer, or
Power.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the label format (float, exponential, integer).
Input:
STRING axis_name[31] This value specifies the axis name.
STRING label_format[31] This value specifies the label format for the specified axis. This
value can be set to: Fixed, Exponential, Integer,
or Power.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
10000310 The specified label format for the axis is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the label type (linear/logarithm).
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
STRING label_type[31] This value returns the label type for the specified axis.
This value can return Linear or Logarithmic.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the label type (linear/logarithm).
Input:
STRING axis_name[31] This value specifies the axis name.
STRING label_type[31] This value specifies the label type for the specified
axis. This value can be set to Linear, or
Logarithmic.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
10000308 The specified label type for the axis is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the labels for the specified axis.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
REAL labels() This value returns an array of labels for the specified axis.
This array must be allocated with enough offsets to contain
the entire list. Use the function xy_axis_labels_get_count()
to get the number of offsets required.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Please see xy_axis_labels_get (p. 1204) in the PCL Reference Manual Examples.
1662 PCL Reference Manual
Modify Action
Description:
This function gets the number of labels defined for the specified axis.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
INTEGER nlabels This value returns the number of labels defined for the
specified axis.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the labels for the specified axis.
Input:
STRING axis_name[31] This value specifies the axis name.
REAL labels() This value specifies an array of labels for the
specified axis.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the axis line style.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
STRING line_style[30] This value returns the curve style for the specified axis.
This value can return Solid, Dotted, DotDash,
ShortDash, LongDash, or OddDash.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the axis line style.
Input:
STRING axis_name[31] This value specifies the axis name.
STRING line_style[30] This value specifies the curve style for the specified
axis. This value can be set to: Solid, Dotted,
DotDash, ShortDash, LongDash, or OddDash.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000201 The specified line style is invalid. Please choose another from the option menu.
10000302 A current axis has not been defined.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the display location.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
STRING display_location[16] This value returns the location of the axis. This value
can return TopBottom, Top, Bottom,
LeftRight, Left, Right, or None.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the display location.
Input:
STRING axis_name[31] This value specifies the axis name.
STRING display_location[16] This value specifies the location of the axis. This value
can be set to TopBottom, Top, Bottom,
LeftRight, Left, Right, or None.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000302 A current axis has not been defined.
10000304 The specified axis display location is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the number of values for the specified axis.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
INTEGER num_vals This value returns the number of values for the
specified axis.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the number of values for the specified axis.
Input:
STRING axis_name[31] This value specifies the axis name.
INTEGER num_vals This value specifies the number of values for the
specified axis.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
10000306 The specified number of values for the axis is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the number of significant digits.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
INTEGER sig_digits This value returns the number of significant digits for
the specified axis.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the number of significant digits.
Input:
STRING axis_name[31] This value specifies the axis name.
INTEGER sig_digits This value specifies the number of significant digits for the
specified axis.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the axis thickness.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
INTEGER thickness This value returns the axis thickness.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the axis thickness.
Input:
STRING axis_name[31] This value specifies the axis name.
INTEGER thickness This value specifies the axis thickness. This value must be
greater than 0 and less than 101.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000302 A current axis has not been defined.
10000303 The specified thickness for the axis is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the ticmark display type (none/primary/secondary).
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
STRING ticmark_type[31] This value returns the ticmark display type for the
specified axis. The value returned can be Primary,
Secondary, PrimarySecondary, or None.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the ticmark display type.
Input:
STRING axis_name[31] This value specifies the axis name.
STRING ticmark_type[31] This value specifies the ticmark display type for the
specified axis. This value can be set to Primary,
Secondary, PrimarySecondary, or None.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
10000309 The specified display type for the axis is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function gets the ticmark attributes.
Input:
STRING axis_name[31] This value specifies the axis name.
STRING prim_sec[31] This value specifies the primary or secondary
ticmark. This value can be set to Primary,
Secondary, or Both.
Output:
STRING location[31] This value returns the location of the ticmark. This
value can return Inside, or Outside.
INTEGER thickness This value returns the ticmark thickness. This
value should be greater than 0 and less than 51.
INTEGER color_index This value returns the ticmark color. See the
remarks below for more information.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000302 A current axis has not been defined.
13000064 XY axis not found
Remarks:
Example:
Please see xy_axis_tic_get (p. 1227) in the PCL Reference Manual Examples.
Description:
This function gets the number of secondary ticmarks.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
INTEGER num_sec_tick This value returns the number of secondary ticmarks
found. This value should be greater than 0 and less than
51.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000302 A current axis has not been defined.
13000064 XY axis not found
Example:
Description:
This function sets the number of secondary ticmarks.
Input:
STRING axis_name[31] This value specifies the axis name.
INTEGER num_sec_tick This value specifies the number of secondary
ticmarks. This value should be greater than 0 and
less than 51.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000302 A current axis has not been defined.
10000400 The specified number of ticmarks for the axis is invalid.
50 > number_of_ticmarks > 1.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Example:
Description:
This function sets the ticmark attributes.
Input:
STRING axis_name[31] This value specifies the axis name.
STRING prim_sec[] This value specifies the primary or secondary ticmark.
STRING location[] This value specifies the location of the ticmark.
INTEGER thickness This value specifies the ticmark thickness.
INTEGER color_index This value specifies the ticmark color. See the remarks
below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000010 The color index has returned an invalid value.
10000013 Invalid option given to XY routine.
10000302 A current axis has not been defined.
10000303 The specified thickness for the axis is invalid.
10000304 The specified axis display location is invalid.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Remarks:
Example:
Description:
This function gets the title attributes.
Input:
STRING axis_name[31] This value specifies the axis name.
Output:
STRING title[256] This value returns the title text for the specified axis.
INTEGER font_size This value returns the font size of the title text. This
value will be set to 8, 10, 12, 14, 18, or 24.
INTEGER title_color This value returns the title color for the specified axis.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000013 Invalid option given to XY routine.
13000064 XY axis not found
Example:
Description:
This function sets the title attributes.
Input:
STRING axis_name[31] This value specifies the axis name.
STRING title[256] This value specifies the title text for the specified axis.
INTEGER font_size This value specifies the font size of the title text.
INTEGER title_color This value specifies the title color for the specified axis.
See the remarks below for more information. This value
can be set to 8, 10, 12, 14, 18, or 24.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000006 The XY font name typed in is invalid. Please input a valid font name.
10000009 The specified text is invalid. Please input a valid text string.
10000010 The color index has returned an invalid value.
10000013 Invalid option given to XY routine.
13000004 Duplicate entry exists in table
13000064 XY axis not found
13000214 No corresponding message available
Remarks:
Example:
Description:
This function gets the curve color index.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
INTEGER color_index This value returns the color index for the specified
curve.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the curve color index.
Input:
STRING curve_name[31] This value specifies the curve name.
INTEGER color_index This value specifies the color index for the specified
curve. See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000010 The color index has returned an invalid value.
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Remarks:
Example:
Description:
This function gets the display symbol flag.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
LOGICAL symbol_flag This value returns the display symbol flag. This value
will be set to TRUE if the curve symbols are to be
displayed, FALSE if they are not.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets display symbol flag.
Input:
STRING curve_name[31] This value specifies the curve name.
LOGICAL symbol_flag This value specifies, when set to TRUE, that the
curve symbols should be displayed, FALSE if they
are not.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the last data point to be displayed.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
INTEGER end_point This value returns the end point for the specified
curve.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the last data point to be displayed.
Input:
STRING curve_name[31] This value specifies the curve name.
INTEGER end_point This value specifies the end point for the specified
curve.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
10000107 The specified ending point is invalid. Please input another ending point in the
databox.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the display frequency of data points for the curve.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
INTEGER frequency This value returns the display frequency value for the
specified curve.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the display frequency of data points for the curve.
Input:
STRING curve_name[31] This value specifies the curve name.
INTEGER frequency This value specifies the display frequency value for the
specified curve.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
10000108 The specified frequency is invalid. Please input another frequency in the databox.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the curve fit function.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
STRING fit_function[30] This value returns the curve fit function. This value
can return Linear, Scatter, Spline, or
LeastSquares.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the curve fit function.
Input:
STRING curve_name[31] This value specifies the curve name.
STRING fit_function[30] This value specifies the curve fit function. This value
can be set to Linear, Scatter, Spline, or
LeastSquares.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
10000200 The specified fit function is invalid. Please choose another.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the curve style.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
STRING curve_style[31] This value returns the curve style. This value can return Solid,
Dotted, DotDash, ShortDash, LongDash, or
OddDash.
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the curve style.
Input:
STRING curve_name[31] This value specifies the curve name.
STRING curve_style[31] This value specifies the curve style. This value can be set to
Solid, Dotted, DotDash, ShortDash, LongDash, or
OddDash.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
10000201 The specified line style is invalid. Please choose another from the option menu.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the number of curves per parametric cubic for least squares fit.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
INTEGER num_line_seg This value returns the number of line segments
generated per parametric cubic curve.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the number of curves per parametric cubic for least squares fit.
Input:
STRING curve_name[31] This value specifies the curve name.
INTEGER num_line_seg This value specifies the number of line segments
generated per parametric cubic curve.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the number of parametric cubic curves.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
INTEGER num_curves This value returns the number of parametric cubic curves
generated.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the number of parametric cubic curves.
Input:
STRING curve_name[31] This value specifies the curve name.
INTEGER num_curves This value specifies the number of parametric cubic
curves to generate.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function renames a curve.
Input:
STRING curve_name[31] This value specifies the current name of the curve.
STRING new_name[] This value specifies the new name to be assigned.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000102 The specified curve name is invalid.
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the first data point to be displayed.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
INTEGER start_point This value returns the start point for the specified curve.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the first data point to be displayed.
Input:
STRING curve_name[31] This value specifies the curve name.
INTEGER start_point This value specifies the start point for the specified
curve.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
10000106 The specified starting point is invalid. Please input another starting point in the
databox.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the symbol color.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
INTEGER symbol_color This value returns the symbol color for the specified
curve.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets symbol color.
Input:
STRING curve_name[31] This value specifies the curve name
INTEGER symbol_color This value specifies the symbol color for the specified curve.
See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Remarks:
Example:
Description:
This function gets the symbol.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
STRING symbol[30] This value returns the symbol for the specified curve.
See the remarks below for more information.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000104 A current curve has not been defined.
13000067 XY curve not found
Remarks:
Example:
Description:
This function sets the symbol.
Input:
STRING curve_name[31] This value specifies the curve name.
STRING symbol[30] This value specifies the symbol for the specified curve. See
the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
10000109 The specified symbol is invalid. Please choose another symbol from the option
menu.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Remarks:
Example:
Description:
This function gets the symbol size.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
INTEGER symbol_size This value returns the symbol size for the specified curve.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets symbol size.
Input:
STRING curve_name[31] This value specifies the curve name.
INTEGER symbol_size This value specifies the symbol size for the specified
curve.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
1706 PCL Reference Manual
Modify Action
Example:
Description:
This function gets the text attributes.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
STRING text[256] This value returns the text for the specified curve.
INTEGER text_color This value returns the color index of the text.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the text attributes.
Input:
STRING curve_name[31] This value specifies the curve name.
STRING text[256] This value specifies the text for the specified
curve.
INTEGER text_color This value specifies the color index of the text.
See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
10000009 The specified text is invalid. Please input a valid text string.
10000010 The color index has returned an invalid value.
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Remarks:
Example:
1708 PCL Reference Manual
Modify Action
Description:
This function gets the curve thickness.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
INTEGER thickness This value returns the curve thickness.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the curve thickness.
Input:
STRING curve_name[31] This value specifies the curve name.
INTEGER thickness This value specifies the curve thickness. This value
must be greater than 0 and less than 51.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
10000202 The specified curve thickness is invalid. Please choose another from the slider.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the value of X increment to use when only Y data has been given.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
REAL x_delta This value returns the X increment value to use when only
Y data is given.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the value of X increment to use when only Y data has been given.
Input:
STRING curve_name[31] This value specifies the curve name.
REAL x_delta This value specifies the X increment value to use when
only Y data is given.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the initial value of X to use as data for curve when only Y data has been given. If
X,Y pairs are given, then this value will not be used.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
REAL x_init This value returns the X initial value to use when only
Y data is given.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the initial value of X to use as data for curve when only Y data has been given. If
X,Y pairs are given, then this value will not be used.
Input:
STRING curve_name[31] This value specifies the curve name.
REAL x_init This value specifies the X initial value to use when only Y
data is given.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the X scale factor.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
REAL x_factor This value returns the X scale factor for the specified
curve.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the X scale factor.
Input:
STRING curve_name[31] This value specifies the curve name.
REAL x_factor This value specifies the X scale factor for the specified
curve.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the Y scale factor.
Input:
STRING curve_name[31] This value specifies the curve name.
Output:
REAL y_factor This value returns the Y scale factor for the specified
curve.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
Description:
This function sets the Y scale factor.
Input:
STRING curve_name[31] This value specifies the curve name.
REAL y_factor This value specifies the Y scale factor for the specified
curve.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000004 Duplicate entry exists in table
13000067 XY curve not found
Example:
Description:
This function gets the legend attributes.
Input:
None.
Output:
REAL location(2) This value returns the location of the legend. Offset
1 will specify the X location and offset 2 will specify
the Y location. These values can range from 0.0 to
100.0.
REAL width This value returns the width of the legend.
REAL height This value returns the height of the legend.
INTEGER bgcolor This value returns the background color of the
legend.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
10000705 There is no current window specified.
13000063 XY window not found
13000065 XY legend not found
Example:
Description:
This function sets the legend attributes.
Input:
REAL location(2) This value specifies the location of the legend. Offset 1
will specify the X location and offset 2 will specify the Y
location. These values can range from 0.0 to 100.0.
REAL width This value specifies the width of the legend.
REAL height This value specifies the height of the legend.
INTEGER bgcolor This value specifies the background color of the legend.
See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000007 The X and Y location must both be in %. This is a percentage of the XY window
from the top left corner. Please input valid X and Y locations.
10000010 The color index has returned an invalid value.
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
13000065 XY legend not found
Remarks:
Example:
Description:
This function gets the border attributes.
Input:
None.
Output:
STRING style[30 This value returns the curve style of the legend. This value can return
Solid, Dotted, DotDash, ShortDash, LongDash, or OddDash.
INTEGER border_color This value returns the border color index of the legend.
INTEGER <Return This function returns a value of 0 when executed successfully and a non
Value> zero value to indicate a change in status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
13000063 XY window not found
13000065 XY legend not found
Example:
Description:
This function sets the border attributes.
Input:
STRING style[30] This value specifies the curve style of the legend. This value can
be set to Solid, Dotted, DotDash, ShortDash,
LongDash, or OddDash.
INTEGER border_color This value specifies the border color index of the legend. See the
remarks below for more information.
Output:
INTEGER <Return This function returns a value of 0 when executed successfully
Value> and a non zero value to indicate a change in status or an error.
Error Conditions:
10000010 The color index has returned an invalid value.
10000201 The specified line style is invalid. Please choose another from the option menu.
13000004 Duplicate entry exists in table
13000063 XY window not found
13000065 XY legend not found
Remarks:
Example:
xy_legend_display_border_get (border_flag)
Description:
This function gets the display border flag.
Input:
None.
Output:
LOGICAL border_flag This value returns the display border status value. When
this value is set to TRUE, the display border for the legend
will be shown. If this value is set to FALSE, the display
border for the legend will not be shown.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000063 XY window not found
13000065 XY legend not found
Example:
xy_legend_display_border_set (border_flag)
Description:
This function sets the display border flag.
Input:
LOGICAL border_flag This value specifies, when set to TRUE that the display
border for the legend will be shown. If this value is set to
FALSE, the display border for the legend will not be
shown.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000004 Duplicate entry exists in table
13000063 XY window not found
13000065 XY legend not found
Example:
xy_legend_display_get (legend_flag)
Description:
This function gets the display legend flag.
Input:
None.
Output:
LOGICAL legend_flag This value returns the display legend status value.
When this value is set to TRUE, the display legend
will be shown. If this value is set to FALSE, the
display legend will not be shown.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
13000063 XY window not found
13000065 XY legend not found
Example:
xy_legend_display_set (legend_flag)
Description:
This function sets the display legend flag.
Input:
LOGICAL legend_flag This value specifies, when set to TRUE that the display
legend will be shown. If this value is set to FALSE, the
display legend will not be shown.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000004 Duplicate entry exists in table
13000063 XY window not found
13000065 XY legend not found
Example:
xy_legend_display_title_get (title_flag)
Description:
This function gets the display title flag.
Input:
None.
Output:
LOGICAL title_flag This value returns the display title flag for the legend. When
this value is set to TRUE, the display legend title will be
shown. If this value is set to FALSE, the display legend title
will not be shown.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000063 XY window not found
13000065 XY legend not found
Example:
xy_legend_display_title_set (title_flag)
Description:
This function sets the display title flag.
Input:
LOGICAL title_flag This value specifies, when set to TRUE that the display
legend title will be shown. If this value is set to FALSE, the
display legend title will not be shown.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
13000004 Duplicate entry exists in table
13000063 XY window not found
13000065 XY legend not found
Example:
Description:
This function gets the text attributes for the legend.
Input:
None.
Output:
STRING legend_text[25 This value returns the text for the legend.
6]
INTEGER text_color This value returns the color index of the text.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
13000063 XY window not found
13000065 XY legend not found
Example:
Description:
This function sets the text attributes for the legend.
Input:
STRING legend_text[25 This value specifies the text for the legend.
6]
INTEGER text_color This value specifies the color index of the text. See the remarks
below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
10000009 The specified text is invalid. Please input a valid text string.
10000010 The color index has returned an invalid value.
13000004 Duplicate entry exists in table
13000063 XY window not found
13000065 XY legend not found
Remarks:
Example:
xy_title_current_set (title_name)
Description:
This function sets the current title.
Input:
STRING title_name[256] This value specifies the current title name.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000005 The specified XY title name is invalid. Please Input a valid title name that is 31
characters or less and contains no embedded blanks.
13000068 XY title not found
Example:
Description:
This function gets the text font size.
Input:
STRING title_name[256] This value specifies the title name.
Output:
INTEGER font_size This value returns the font size of the specified title.
This value can return 8, 10, 12, 14, 18, or 24.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000101 The specified title does not exist in the database.
13000068 XY title not found
Chapter 7: XY Plot Functions 1731
Modify Action
Example:
Description:
This function sets the text font size.
Input:
STRING title_name[256] This value specifies the title name.
INTEGER font_size This value specifies the font size of the specified title. This
value can be set to 8, 10, 12, 14, 18, or 24.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000006 The XY font name typed in is invalid. Please input a valid font name.
10000101 The specified title does not exist in the database.
13000004 Duplicate entry exists in table
13000068 XY title not found
Example:
Description:
This function renames a title.
Input:
STRING title_name[] This value specifies the current name of the title.
STRING new_name[] This value specifies the new name to be assigned.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000005 The specified XY title name is invalid. Please Input a valid title name that is 31
characters or less and contains no embedded blanks.
10000100 There is no current title defined.
13000004 Duplicate entry exists in table
13000068 XY title not found
Example:
Description:
This function gets the text attributes.
Input:
STRING title_name[256] This value specifies the title name.
Output:
STRING text[256] This value returns the text of the specified title.
REAL location(2) This value returns the location of the text. Offset 1 will
specify the X location and offset 2 will specify the Y
location. These values can range from 0.0 to 100.0.
INTEGER text_color This value returns the color index of the text.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000101 The specified title does not exist in the database.
13000068 XY title not found
Example:
Description:
This function sets the text attributes.
Input:
STRING title_name[256] This value specifies the title name.
STRING text[256] This value specifies the text of the specified title.
REAL location(2) This value specifies the location where the text is to be
placed. Offset 1 will specify the X location and offset 2
will specify the Y location. These values can range from
1.0 to 100.0.
INTEGER text_color This value specifies the color index of the text. See the
remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000007 The X and Y location must both be in %. This is a percentage of the XY window
from the top left corner. Please input valid X and Y locations.
10000009 The specified text is invalid. Please input a valid text string.
10000010 The color index has returned an invalid value.
10000101 The specified title does not exist in the database.
13000004 Duplicate entry exists in table
13000068 XY title not found
Remarks:
Example:
Description:
This function gets the graph background color.
Input:
STRING window_name[31] This value specifies the window name.
Output:
INTEGER bgcolor This value returns the background color for the specified
window.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
10000705 There is no current window specified.
13000063 XY window not found
Example:
Description:
This function sets the graph background color.
Input:
STRING window_name[31] This value specifies the window name.
INTEGER bgcolor This value specifies the background color for the specified
window. See the remarks below for more information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
Remarks:
Example:
Description:
This function gets the display border color.
Input:
STRING window_name[31] This value specifies the window name.
Output:
INTEGER border_color This value returns the display border color for the
specified window.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000705 There is no current window specified.
13000063 XY window not found
Example:
Description:
This function sets the display border color.
Input:
STRING window_name[31] This value specifies the window name.
INTEGER border_color This value specifies the display border color for the
specified window. See the remarks below for more
information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
Remarks:
Example:
Description:
This function gets the border curve style.
Input:
STRING window_name[31] This value specifies the window name.
Output:
STRING curve_style[31] This value returns the border curve style for the specified
window. This value can return Solid, Dotted,
DotDash, ShortDash, LongDash, or OddDash.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000012 Internal XY string lookup failure.
10000705 There is no current window specified.
13000063 XY window not found
Example:
Description:
This function sets the border curve_style.
Input:
STRING window_name[31] This value specifies the window name.
STRING curve_style[31] This value specifies the border curve style for the
specified window. This value can be set to: Solid,
Dotted, DotDash, ShortDash, LongDash, or
OddDash.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000201 The specified line style is invalid. Please choose another from the option menu.
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
Example:
Description:
This function gets the border thickness.
Input:
STRING window_name[31] This value specifies the window name.
Output:
INTEGER thickness This value returns the window border thickness. The
value returned will be greater than 0 and less than
101.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000705 There is no current window specified.
13000063 XY window not found
Example:
Description:
This function sets the border thickness.
Input:
STRING window_name[31] This value specifies the window name.
INTEGER thickness This value specifies the window border thickness. This
value must be greater than 0 and less than 101.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
Example:
Description:
This function gets the display graph border flag.
Input:
STRING window_name[31] This value specifies the window name.
Output:
LOGICAL border_flag This value returns the display graph border flag for the
specified window. When this value is TRUE, the display
graph border should be displayed. When this value is set to
FALSE, the display graph border should not be displayed.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000705 There is no current window specified.
13000063 XY window not found
Example:
Description:
This function sets the display graph border flag.
Input:
STRING window_name[31] This value specifies the window name.
LOGICAL border_flag This value specifies, when set to TRUE, that the display
graph border should be shown. When this value is set to
FALSE, the display graph border should not be shown.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
Example:
Description:
This function gets the ID of a window from the name.
Input:
STRING window_name[31] This value specifies the name of the xy window.
Output:
INTEGER window_id This value returns the id of the xy window.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
13000063 XY window not found
Chapter 7: XY Plot Functions 1745
Modify Action
Example:
Rename Action
This section is used to describe some of the functions used to implement the Rename actions.
Description:
This function renames a xy window.
Input:
STRING window_name[31] This value specifies the current name of window.
STRING new_name[] This value specifies the new name to be assigned.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000700 The specified window name is invalid. Enter a window name that is less than 31
characters and that has no embedded blanks.
10000705 There is no current window specified.
13000004 Duplicate entry exists in table
13000063 XY window not found
Example:
Delete Action
This section is used to describe some of the functions used to implement the Delete actions.
xy_curve_delete (curve_name)
Description:
This function deletes a curve.
Input:
STRING curve_name[31] This value specifies the name of the curve to be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
10000104 A current curve has not been defined.
13000067 XY curve not found
Example:
xy_title_delete (title_name)
Description:
This function deletes a title.
Input:
STRING title_name[256] This value specifies the name of the title to be deleted.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
10000100 There is no current title defined.
13000068 XY title not found
Example:
8 FlightLoads Functions
Introduction 1750
General Utilities 1751
Modeling Utilities 1754
AeroDynamic Utilities 1782
AeroElastic Utilities 1791
Loadsbrowser Utilities 1801
1750 PCL Reference Manual
Introduction
Introduction
The purpose of this chapter is to list functions used to create and manipulate various parts of the Flight
Loads product.
General Utilities These are the general functions that store the information that is used by
the various parts of Flight Loads in the database.
Modeling Utilities These functions are used in creating, modifying, and deleting the various
parts of the Flight Loads model. It also contains functions that are used to
create and manipulate Monitor Points and the Flight Loads Modeling
Management environment.
AeroDynamic Utilities These functions are used in the creation and manipulation of various
Aerodynamic activities like Steady Aerodynamics.
AeroElastic Utilities These functions are used in the creation and manipulation of the various
Aeroelasticity activities like Splines.
Loadsbrowser Utilities These functions are used by the Flight Loads Loadsbrowser.
Chapter 8: FlightLoads Functions 1751
General Utilities
General Utilities
This section explains the functions that are used through out Flight Loads to manipulate the settings of
the general and Flight Loads part specific options.
Description:
This function retrieves the value of the Basic Aero Coord Frame and the value of the Dimensional
Angle and Rates toggle from the database.
Input:
INTEGER lbccframe_id This value specifies the id of the Basic Aero Coord
Frame.
LOGICAL dim_angle This value specifies the state of the dimensional angle
and rates toggle
Output:
None.
Remarks:
None.
Example:
None
.
Description:
This function stores the value of the Basic Aero Coord Frame and the value of the Dimensional
Angle and Rates toggle in the database.
Input:
INTEGER lbccframe_id This value specifies the id of the Basic Aero Coord Frame.
LOGICAL dim_angle This value specifies the state of the dimensional angle and
rates toggle
Output:
None.
1752 PCL Reference Manual
General Utilities
Remarks:
None.
Example:
None.
.
Description:
This function stores the Aero Modeling options in the database.
Input:
LOGICAL cre_geom TRUE: if geometry is to be created; FALSE
otherwise.
LOGICAL auto_mchk TRUE: if auto model checking is to be done;
FALSE otherwise.
INTEGER strt_elem, This value specifies the starting element id
number.
INTEGER elem_inc This value specifies the element increment value.
INTEGER int_grp This value specifies the interference group id
number.
REAL warp_tol, This value specifies the warp tolerance value.
REAL edge_ratio This value specifies the edge ratio value.
Output:
None.
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1753
General Utilities
Description:
This function stores the SuperGroup type and name in the database.
Input:
STRING type This value specifies the type of SuperGroup to store.
(FLAT_PLATE or THREED)
STRING name This value specifies the name of the SuperGroup to store.
Output:
None.
Remarks:
None.
Example:
None.
flds_store_start_elem_id ( strt_elem )
Description:
This function stores the Starting Element id in the database.
Input:
INTEGER strt_elem This value specifies the starting element id.
Output:
None.
Remarks:
None.
Example:
None.
1754 PCL Reference Manual
Modeling Utilities
Modeling Utilities
This section explains the functions that are used in defining the Flight Loads model and maintaining it
and its environment.
Description:
This function calculates the fringe value for each QUAD in the current group.
Input:
REAL threshold The comparison value to indicate element has failed.
Threshold is a lower limit.
STRING swtch_val The value of the switch that determines which equation
is to be used in calculating the Boxes/Wavelength.
(Dimensional (v and f) or Nondimensional (c and
k))
REAL dbox1_val The Minimum Velocity or the Reference Length
depending on what the value of swtch_val is set to
REAL dbox2_val The Maximum Cyclic Frequency or the Maximum
Reduced Frequency depending on what the value of
swtch_val is set to
Output:
STRING grp_name Current group label
REAL min_val Minimum fringe factor for QUADS tested
REAL max_val Maximum fringe factor for QUADS tested
INTEGER table_id ID of scalar element fringe results table
INTEGER <Return Value> 0 = Success; otherwise a problem was encountered
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1755
Modeling Utilities
Description:
This function deletes the Aero element and all its associated entities. This action includes the deletion
of the property set and the associated group containing the nodes and boxes/beams, geometries, and
removes the nodes and boxes/beams. If specified by the user, the surface/curve and the points used
to create the Aero element are also deleted. Moreover, the Splines, Control Devices and Fields are
deleted if their respective application regions are emptied due to the Aero element deletion.
Input:
STRING element_name This value specifies the name of the element to be deleted.
LOGICAL delete_geom TRUE if the associated geometries are to be deleted;
FALSE otherwise.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1 This is am internal status condition. There is no corresponding status message
in the message database.
-1 This is am internal status condition. There is no corresponding status message
in the message database.
Remarks:
None.
Example:
None.
1756 PCL Reference Manual
Modeling Utilities
Description:
This function creates the General Contols control device
Input:
STRING device_name Name of the General Controller
STRING units_label Units label for the General Controller
STRING super_group_name Name of the current SuperGroup
Output:
INTEGER <Return Value> 0 = Success; otherwise there is a problem
Remarks:
None.
Example:
None.
Description:
This function modifies the specified General Controls control device.
Input:
STRING device_name Name of the General Controller
STRING units_label Units label for the General Controller
STRING super_group_nam Name of the current SuperGroup
e
Output:
INTEGER <Return Value> 0 = Success; otherwise there is a problem
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1757
Modeling Utilities
Description:
This function deletes the Aero LBC from the database.
Input:
INTEGER num_names This value specifies the number of selected LBCs.
STRING name_array() This value specifies the array of selected LBC names to be
deleted.
Output:
INTEGER <Return This function returns a value of 0 when executed
Value> successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
-1 This is am internal status condition. There is no corresponding status message
in the message database.
Remarks:
None.
Example:
None.
1758 PCL Reference Manual
Modeling Utilities
Description:
This function checks the validity of the entered SuperGroup Name, to create it, to associate the
appropriate Aero Groups to it, and to make it current if need be.
Input:
STRING sg_name This value specifies the name of the SuperGroup to create.
STRING sg_type This value specifies the type of the SuperGroup. (FLAT_PLATE
or THREED)
INTEGER num_sel_grps This value specifies the number of Aero Groups selected.
STRING sel_gnames() This value specifies the array listing the selected Aero Group
Names.
LOGICAL mk_cur_flag TRUE if the SuperGroup is to be made current; FALSE otherwise.
Output:
None.
Remarks:
None.
Example:
None.
Description:
This function makes the selected SuperGroup current.
Input:
STRING sg_type This value specifies the type of the SuperGroup to make
current. (FLAT_PLATE or THREED)
STRING sg_name This value specifies the name of the SuperGroup to make
current.
Output:
None.
Chapter 8: FlightLoads Functions 1759
Modeling Utilities
Remarks:
None.
Example:
None.
Description:
This function deletes the list of given SuperGroup names.
Input:
STRING sg_type This value specifies the type of the SuperGroup to delete.
(FLAT_PLATE or THREED)
INTEGER num_sel_sgrps This value specifies the number of SuperGroups selected.
STRING sg_names() This value specifies the array listing the selected
SuperGroup Names.
Output:
None.
Remarks:
None.
Example:
None.
1760 PCL Reference Manual
Modeling Utilities
Description:
This function checks the validity of the entered SuperGroup Name, modifies the selected
SuperGroup and reassociates the appropriate Aero Groups to it.
Input:
STRING sg_name This value specifies the name of the SuperGroup to modify.
STRING new_sg_name This value specifies the new name of the SuperGroup to be used
if different than sg_name.
STRING sg_type This value specifies the type of the SuperGroup. (FLAT_PLATE
or THREED)
INTEGER num_sel_grps This value specifies the number of Aero Groups selected.
STRING sel_gnames() This value specifies the array listing the selected Aero Group
Names.
Output:
None.
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1761
Modeling Utilities
Description:
This function rebuilds all the Aero Groups and the SuperGroups.
Input:
INTEGER num_entities This value specifies the number of selected Lifting
Surface/Body names.
STRING entity_names() This value specifies the array listing the selected Lifting
Surface/Body names.
INTEGER num_aero_grps This value specifies the number of existing Aero Groups.
STRING aero_grps() This value specifies the array listing the Aero Group Names.
STRING crnt_sgrp_name This value specifies the name of the current SuperGroup to
which the selected Lifting Surface/Body names are to be
assigned. This value is left blank if they are not to be assigned
to the current SuperGroup.
Output:
None.
Remarks:
None.
Example:
None.
1762 PCL Reference Manual
Modeling Utilities
Description:
This function creates the monitor points.
Input:
INTEGER aero_or_struct 1 = Aero; 2 = Structural
STRING monitor_name Name of the monitor point
STRING monitor_pt_label Monitor point label
INTEGER num_box Number of box ids specified in box_id_array
INTEGER box_id_array() The array of areodynamic boxes/elements making up the
nonlinear control surface component
INTEGER coord_label The label of the rectangular coordinate system
INTEGER monitor_comp(6) The monitor components
Output:
INTEGER <Return Value> 0 = Success; otherwise there is a problem
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1763
Modeling Utilities
Description:
This function gets the data for the specified Monitor Point.
Input:
STRING monitor_name Name of the monitor point to get
Output:
STRING monitor_pt_label The monitor point label
INTEGER num_elem The number of boxes/elements in the application region
INTEGER app_reg_ent() The array of box/element ids making up the nonlinear
control surface component
INTEGER coordinate_id The label of the rectangular coordinate system
INTEGER monitor_comp(6) The monitor components
INTEGER <Return Value> 0 = Success; otherwise there is a problem
Remarks:
None.
Example:
None.
1764 PCL Reference Manual
Modeling Utilities
Description:
This function modifies the specified monitor point.
Input:
INTEGER aero_or_struct 1 = Aero; 2 = Structural
STRING monitor_name Name of the monitor point to modify
STRING monitor_pt_label Monitor point label
INTEGER num_box Number of box ids specified in box_id_array
INTEGER box_id_array() The array of areodynamic boxes/elements
making up the nonlinear control surface
component
INTEGER coord_label The label of the rectangular coordinate system
INTEGER monitor_comp(6) The monitor components
Output:
INTEGER <Return Value> 0 = Success; otherwise there is a problem
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1765
Modeling Utilities
Description:
This function creates the Nonlinear Control Surface control device.
Input:
STRING device_name This value specifies the name of the Nonlinear Control
Surface.
INTEGER coord_label This value specifies the label of the rectangular
coordinate with y-axis defining the hinge line of the
control surface component.
INTEGER num_box This value specifies the number of box ids specified
in the box_id_array.
INTEGER box_id_array() This value specifies the array of aerodynamic
boxes/elements making up the control surface
component.
REAL effectiveness This value specifies the Control Device effectiveness.
REAL ref_chord_len This value specifies the reference chord length.
REAL ref_area This value specifies the reference area for the Control
Device.
REAL upper_def_limit This value specifies the upper deflection limit
(Radians).
REAL lower_def_limit This value specifies the lower deflection limit
(Radians).
LOGICAL is_up_mom_defined TRUE: if the upper moment is defined; FALSE
otherwise.
REAL upper_mom_limit This value specifies the upper hinge moment limit.
LOGICAL is_lo_mom_defined TRUE: if the lower moment is defined; FALSE
otherwise.
REAL lower_mom_limit This value specifies the lower hinge moment limit.
1766 PCL Reference Manual
Modeling Utilities
STRING up_def_limit_field This value specifies the Field name containing the
upper deflection limits vs. Dynamic pressure. If
up_def_limit_field="" then upper_def_limit value will
be used.
STRING low_def_limit_field This value specifies the Field name containing the
lower deflection limits vs. Dynamic Pressure. If
low_def_limit_field="" then lower_def_limit value
will be used.
STRING cntrl_param_unit Degrees or Rads
STRING super_group_name Current SuperGroup name
Output:
INTEGER <Return Value> 0 = Success; otherwise there is a problem
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1767
Modeling Utilities
Description:
This function modifies the specified Nonlinear Control Surface control device.
Input:
STRING device_name This value specifies the old name of the Nonlinear Control
Surface.
STRING new_dev_name This value specifies the new name of the Nonlinear Control
Surface.
INTEGER coord_label This value specifies the label of the rectangular coordinate
with y-axis defining the hinge line of the control surface
component.
INTEGER num_box This value specifies the number of box ids specified in the
box_id_array.
INTEGER box_id_array() This value specifies the array of aerodynamic boxes/elements
making up the control surface component.
REAL effectiveness This value specifies the Control Device effectiveness.
REAL ref_chord_len This value specifies the reference chord length.
REAL ref_area This value specifies the reference area for the Control Device.
REAL upper_def_limit This value specifies the upper deflection limit (Radians).
REAL lower_def_limit This value specifies the lower deflection limit (Radians).
LOGICAL is_up_mom_defined TRUE: if the upper moment is defined; FALSE otherwise.
REAL upper_mom_limit This value specifies the upper hinge moment limit.
LOGICAL is_lo_mom_defined TRUE: if the lower moment is defined; FALSE otherwise.
REAL lower_mom_limit This value specifies the lower hinge moment limit.
STRING up_def_limit_field This value specifies the Field name containing the upper
deflection limits vs. Dynamic pressure. If
up_def_limit_field="" then upper_def_limit value will be
used.
1768 PCL Reference Manual
Modeling Utilities
STRING low_def_limit_field This value specifies the Field name containing the lower
deflection limits vs. Dynamic Pressure. If
low_def_limit_field="" then lower_def_limit value will be
used.
STRING cntrl_param_unit Degrees or Rads
STRING super_group_name Current SuperGroup name
Output:
INTEGER <Return Value> 0 = Success; otherwise there is a problem
Remarks:
None.
Example:
None.
Description:
This function creates the Rigid Body Motion control device.
Input:
STRING rbm_type ANGLEA, SIDES, ROLL, PITCH, or YAW
STRING rbm_status Linear, Nonlinear, or Do Not Create
STRING super_group_name Name of the current SuperGroup. This is the SuperGroup the
rigid body motion will be associated with.
Output:
INTEGER <Return Value> 0 = Success; otherwise there is a problem
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1769
Modeling Utilities
Description:
This function modifies the specified Rigid Body Motion control device.
Input:
STRING rbm_type ANGLEA, SIDES, ROLL, PITCH, or YAW
STRING rbm_status Linear, Nonlinear, or Do Not Create
STRING super_group_name Name of the current SuperGroup. This is the SuperGroup the
rigid body motion will be associated with.
Output:
INTEGER <Return Value> 0 = Success; otherwise there is a problem
Remarks:
None.
Example:
None.
Description:
This function gets the status of the specified Rigid Body Motion in the specified SuperGroup.
Input:
STRING rbm_type Name of the specified Rigid Body Motion (ANGLEA,
SIDES, ROLL, PITCH, or YAW)
STRING super_group_name Name of the current SuperGroup
Output:
STRING rbm_status Linear, Nonlinear, or Do Not Create
INTEGER <Return Value> 0 = Success; otherwise there is a problem
Remarks:
None.
Example:
None.
1770 PCL Reference Manual
Modeling Utilities
Description:
This function creates the flat plate Aero body given the information available on a CAERO2 card, and
the coordinates of the point X1 and the body length.
Input:
STRING body_name This value specifies the user defined name of the body.
STRING body_orient This value specifies the orientation. (Z_BODY, Y_BODY,
ZY_BODY)
REAL xyz1 This value specifies the coordinates of the X1 point.
REAL x12 This value specifies the length of the body.
INTEGER starting_elem_id This value specifies the starting element ID.
INTEGER interference_id This value specifies the interference group ID.
INTEGER coordinate_id This value specifies the reference coordinate ID.
INTEGER num_slender This value specifies the number of seeds for slender body.
REAL slender_array This value specifies the seed array for slender body.
INTEGER num_interf This value specifies the number of seeds for interference
body.
REAL interf_array This value specifies the seed array for interference body.
REAL half_width_array This value specifies the slender body half width distribution.
REAL interf_half_width This value specifies the interference body half width value.
REAL interf_aspect_ratio This value specifies the interference body aspect ratio.
INTEGER num_interf_theta This value specifies the number of interference body theta
values.
REAL interf_theta_array This value specifies the interference body theta distribution.
LOGICAL keep_geom TRUE if the curve/points are to be kept; FALSE otherwise.
STRING exist_curve_name This value specifies the name of an existing curve("" if not
used).
INTEGER aero_coord_id This value specifies the label of the Aero coordinate system.
Output:
Chapter 8: FlightLoads Functions 1771
Modeling Utilities
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
6026016 The group already exists in the database.
1 This is am internal status condition. There is no corresponding status message in the
message database.
Remarks:
None.
Example:
None.
1772 PCL Reference Manual
Modeling Utilities
Description:
This function modifies the specified flat plate body with the updated property/mesh values. The group
is updated with the new elements and nodes if necessary.
Input:
STRING body_name This value specifies the user defined name of the body.
INTEGER starting_elem_id This value specifies the starting element ID.
INTEGER interf_group_id This value specifies the interference group ID.
INTEGER coordinate_id This value specifies the reference coordinate system ID
for X1.
INTEGER num_slender This value specifies the number of slender mesh seeds.
REAL slender_mesh() This value specifies the array of mesh seed distribution
for the slender body.
INTEGER num_interf This value specifies the number of interference mesh
seeds.
REAL interf_mesh() This value specifies the array of mesh seed distribution
for the interference body.
REAL slender_half_widt This value specifies the array of slender body half width
h() distribution.
INTEGER num_theta This value specifies the number of theta values.
REAL interf_body_theta( This value specifies the array of interference body theta
) distribution.
REAL interf_half_width This value specifies the interference body half width
value.
REAL interf_aspect_rati This value specifies the interference body aspect ratio.
o
STRING new_body_name This value specifies the new name of the body.
INTEGER aero_coord_id This value specifies the ID of the Aero Coordinate
System.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an error.
Chapter 8: FlightLoads Functions 1773
Modeling Utilities
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1 This is am internal status condition. There is no corresponding status message
in the message database.
Remarks:
None.
Example:
None.
1774 PCL Reference Manual
Modeling Utilities
Description:
This function creates a Linear Control Surface control device given the information available on an
AESURF/AELIST cards.
Input:
STRING device_name This value specifies the name of the Control Device.
INTEGER device_type This value specifies the type. (1=SURFACE, 2=GIMBLE,
3=THRUST, 4=GENERAL)
INTEGER coord_label This value specifies the label of the rectangular coordinate
with y-axis defining the hinge line of the control surface
component.
INTEGER num_box This value specifies the number of box ids specified in the
box_id_array.
INTEGER box_id_array() This value specifies the array of aerodynamic boxes/elements
making up the control surface component.
REAL effectiveness This value specifies the Control Device effectiveness.
REAL ref_chord_len This value specifies the reference chord length.
REAL ref_area This value specifies the reference area for the Control Device.
REAL upper_def_limit This value specifies the upper deflection limit (Radians).
REAL lower_def_limit This value specifies the lower deflection limit (Radians).
LOGICAL is_up_mom_defined TRUE: if the upper moment is defined; FALSE otherwise.
REAL upper_mom_limit This value specifies the upper hinge moment limit.
LOGICAL is_lo_mom_defined TRUE: if the lower moment is defined; FALSE otherwise.
REAL lower_mom_limit This value specifies the lower hinge moment limit.
STRING up_def_limit_field This value specifies the Field name containing the upper
deflection limits vs. Dynamic pressure. If
up_def_limit_field="" then upper_def_limit value will be
used.
Chapter 8: FlightLoads Functions 1775
Modeling Utilities
STRING low_def_limit_field This value specifies the Field name containing the lower
deflection limits vs. Dynamic Pressure. If
low_def_limit_field="" then lower_def_limit value will be
used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1 This is am internal status condition. There is no corresponding status message in the
message database.
Remarks:
None.
Example:
None.
1776 PCL Reference Manual
Modeling Utilities
Description:
This function modifies the specified Linear Control Surface.
Input:
STRING device_name This value specifies the name of the Control Device.
STRING new_device_name This value specifies the new name of the Control Device.
INTEGER device_type This value specifies the type. (1=SURFACE, 2=GIMBLE,
3=THRUST, 4=GENERAL)
INTEGER coord_label This value specifies the label of the rectangular coordinate
with y-axis defining the hinge line of the control surface
component.
INTEGER num_box This value specifies the number of box ids specified in the
box_id_array.
INTEGER box_id_array() This value specifies the array of aerodynamic boxes/elements
making up the control surface component.
REAL effectiveness This value specifies the Control Device effectiveness.
REAL ref_chord_len This value specifies the reference chord length.
REAL ref_area This value specifies the reference area for the Control Device.
REAL upper_def_limit This value specifies the upper deflection limit (Radians).
REAL lower_def_limit This value specifies the lower deflection limit (Radians).
LOGICAL is_up_mom_defined TRUE: if the upper moment is defined; FALSE otherwise.
REAL upper_mom_limit This value specifies the upper hinge moment limit.
LOGICAL is_lo_mom_defined TRUE: if the lower moment is defined; FALSE otherwise.
REAL lower_mom_limit This value specifies the lower hinge moment limit.
STRING up_def_limit_field This value specifies the Field name containing the upper
deflection limits vs. Dynamic pressure. If
up_def_limit_field="" then upper_def_limit value will be
used.
Chapter 8: FlightLoads Functions 1777
Modeling Utilities
STRING low_def_limit_field This value specifies the Field name containing the lower
deflection limits vs. Dynamic Pressure. If
low_def_limit_field="" then lower_def_limit value will be
used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1 This is am internal status condition. There is no corresponding status message in the
message database.
Remarks:
None.
Example:
None.
1778 PCL Reference Manual
Modeling Utilities
Description:
This function creates the flat plate surface given the information available on a CAERO card, and
the coordinates of the points X1, X4, and the chord lengths X12 and X43.
Input:
STRING surf_name This value specifies the user defined name of the surface.
REAL xyz1() This value specifies the coordinates of Point 1 in
coordinate_id frame.
REAL xyz4() This value specifies the coordinates of Point 4 in
coordinate_id frame.
REAL x12 This value specifies the X12 edge chord length in the
Aerodynamic coordinate system.
REAL x43 This value specifies the X43 edge chord length in the
Aerodynamic coordinate system.
INTEGER starting_elem_id This value specifies the starting element ID
INTEGER interference_id This value specifies the interference ID.
INTEGER coordinate_id This value specifies the reference coordinate system ID for
X1 and X4.
STRING body_flag This value specifies the body flag. ("None", "All", "All
IGID", "Select")
INTEGER num_bodies This value specifies the number of bodies.
STRING body_name_array( This value specifies the array of body names. (Only used if
) the body_flag is "Select")
INTEGER num_span This value specifies the number of seeds in span direction.
INTEGER num_chord This value specifies the number of seeds in chord direction.
REAL span_array() This value specifies the seed array in the span direction.
REAL chord_array() This value specifies the seed array in the chord direction.
LOGICAL keep_geom TRUE: if the surface/points are to be kept; FALSE otherwise.
STRING exist_surf_name This value specifies the name of an existing surface ("" if not
used)
Chapter 8: FlightLoads Functions 1779
Modeling Utilities
INTEGER aero_coord_id This value specifies the Aero coordinate system id.
LOGICAL auto_connect TRUE if the surface connectivity is to be automatically reset
such that Y4 >= Y1. Where Y1 is the Y coordinate of Point 1
in the Aero coordinate system, Y4 is the Y coordinate of Point
4 in the Aero coordinate system following the right hand rule.
FALSE if the user defined connection is to be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
6026016 The group already exists in the database.
1 This is am internal status condition. There is no corresponding status message in the
message database.
Remarks:
None.
Example:
None.
1780 PCL Reference Manual
Modeling Utilities
Description:
This function modifies the specified flat plate surface with the updated property/mesh values. The
group is updated with the new elements and nodes if necessary.
Input:
STRING surf_name This value specifies the user defined name of the surface.
INTEGER starting_elem_id This value specifies the starting element ID
INTEGER interference_id This value specifies the interference ID.
INTEGER coordinate_id This value specifies the reference coordinate system ID for X1
and X4.
STRING body_flag This value specifies the body flag. ("None", "All", "All IGID",
"Select")
INTEGER num_bodies This value specifies the number of bodies.
STRING body_name_array() This value specifies the array of body names. (Only used if the
body_flag is "Select")
INTEGER num_span This value specifies the number of seeds in span direction.
REAL span_array() This value specifies the seed array in the span direction.
INTEGER num_chord This value specifies the number of seeds in chord direction.
REAL chord_array() This value specifies the seed array in the chord direction.
STRING new_surf_name This value specifies the new name of the surface.
INTEGER aero_coord_id This value specifies the Aero coordinate system id.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1 This is am internal status condition. There is no corresponding status message in the
message database.
Chapter 8: FlightLoads Functions 1781
Modeling Utilities
Remarks:
None.
Example:
None.
1782 PCL Reference Manual
AeroDynamic Utilities
AeroDynamic Utilities
This section explains the functions that are used in defining the Flight Loads dynamics and maintaining
it and its environment.
.
Description:
This function creates the Aerodynamic Force/Q vector.
Input:
STRING vector_name Name of the Force/Q vector
INTEGER coord_label The label of the coordinate frame
INTEGER xz_sym The label of the XZ Symmetry
INTEGER xy_sym The label of the XY Symmetry
REAL mach_num The Mach number
INTEGER num_of_rbm The number of Rigid Body Motions defined
REAL rbm_values() Array of all the defined Rigid Body Motion values
INTEGER num_of_cntrl_dev The number of Control Devices defined. This includes
s General Controllers and both the linear and nonlinear
Control Surfaces.
REAL cntrl_dev_values() Array of all the defined Control Device values
REAL lbc_set_sf The Load.BC Set Scale Factor
INTEGER force The id of the Force field
INTEGER moment The id of the Moment field
STRING force_type Force Type: Structural or Aero
Output:
None.
Remarks:
None.
Example:
None
Chapter 8: FlightLoads Functions 1783
AeroDynamic Utilities
Description:
This function gets the data for the specified Aerodynamic Force/Q vector.
Input:
STRING vector_name Name of the Force/Q vector to get
Output:
INTEGER coord_label The label of the coordinate frame
INTEGER xz_sym The label of the XZ Symmetry
INTEGER xy_sym The label of the XY Symmetry
REAL mach_num The Mach number
INTEGER num_of_rbm The number of Rigid Body Motions defined
REAL rbm_values() Array of all the defined Rigid Body Motion values
INTEGER num_of_cntrl_devs The number of Control Devices defined. This includes
General Controllers and both the linear and nonlinear
Control Surfaces.
REAL cntrl_dev_values() Array of all the defined Control Device values
REAL lbc_set_sf The Load.BC Set Scale Factor
INTEGER force The id of the Force field
INTEGER moment The id of the Moment field
STRING force_type Force Type: Structural or Aero
Remarks:
None.
Example:
None.
1784 PCL Reference Manual
AeroDynamic Utilities
Description:
This function modifies the specified Aerodynamic Force/Q vector.
Input:
STRING vector_name Name of the Force/Q vector to modify
INTEGER coord_label The label of the coordinate frame
INTEGER xz_sym The label of the XZ Symmetry
INTEGER xy_sym The label of the XY Symmetry
REAL mach_num The Mach number
INTEGER num_of_rbm The number of Rigid Body Motions defined
REAL rbm_values() Array of all the defined Rigid Body Motion values
INTEGER num_of_cntrl_devs The number of Control Devices defined. This includes
General Controllers and both the linear and nonlinear Control
Surfaces.
REAL cntrl_dev_values() Array of all the defined Control Device values
REAL lbc_set_sf The Load.BC Set Scale Factor
INTEGER force The id of the Force field
INTEGER moment The id of the Moment field
STRING force_type Force Type: Structural or Aero
Output:
None.
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1785
AeroDynamic Utilities
Description:
This function creates the Aerodynamic Normalwash/Q vector.
Input:
STRING vector_name Name of the Normalwash/Q vector
INTEGER coord_label The label of the coordinate frame
INTEGER xz_sym The label of the XZ Symmetry
INTEGER xy_sym The label of the XY Symmetry
REAL mach_num The Mach number
INTEGER num_of_rbm The number of Rigid Body Motions defined
REAL rbm_values() Array of all the defined Rigid Body Motion values
INTEGER num_of_cntrl_devs The number of Control Devices defined. This includes
General Controllers and both the linear and nonlinear Control
Surfaces.
REAL cntrl_dev_values() Array of all the defined Control Device values
REAL lbc_set_sf The Load.BC Set Scale Factor
INTEGER norm_wash The id of the Normalwash field
Output:
None.
Remarks:
None.
Example:
None.
1786 PCL Reference Manual
AeroDynamic Utilities
Description:
This function gets the data for the specified Aerodynamic Normalwash/Q vector.
Input:
STRING vector_name Name of the Normalwash/Q vector to get
Output:
INTEGER coord_label The label of the coordinate frame
INTEGER xz_sym The label of the XZ Symmetry
INTEGER xy_sym The label of the XY Symmetry
REAL mach_num The Mach number
INTEGER num_of_rbm The number of Rigid Body Motions defined
REAL rbm_values() Array of all the defined Rigid Body Motion values
INTEGER num_of_cntrl_devs The number of Control Devices defined. This includes
General Controllers and both the linear and nonlinear
Control Surfaces.
REAL cntrl_dev_values() Array of all the defined Control Device values
REAL lbc_set_sf The Load.BC Set Scale Factor
INTEGER norm_wash The id of the Normalwash field
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1787
AeroDynamic Utilities
Description:
This function modifies the specified Aerodynamic Normalwas/Q vector.
Input:
STRING vector_name Name of the Normalwash/Q vector to modify
INTEGER coord_label The label of the coordinate frame
INTEGER xz_sym The label of the XZ Symmetry
INTEGER xy_sym The label of the XY Symmetry
REAL mach_num The Mach number
INTEGER num_of_rbm The number of Rigid Body Motions defined
REAL rbm_values() Array of all the defined Rigid Body Motion values
INTEGER num_of_cntrl_devs The number of Control Devices defined. This includes
General Controllers and both the linear and nonlinear
Control Surfaces.
REAL cntrl_dev_values() Array of all the defined Control Device values
REAL lbc_set_sf The Load.BC Set Scale Factor
INTEGER norm_wash The id of the Normalwash field
Output:
None.
Remarks:
None.
Example:
None.
1788 PCL Reference Manual
AeroDynamic Utilities
Description:
This function creates the Aerodynamic Pressure/Q vector.
Input:
STRING vector_name Name of the Pressure/Q vector
INTEGER coord_label The label of the coordinate frame
INTEGER xz_sym The label of the XZ Symmetry
INTEGER xy_sym The label of the XY Symmetry
REAL mach_num The Mach number
INTEGER num_of_rbm The number of Rigid Body Motions defined
REAL rbm_values() Array of all the defined Rigid Body Motion values
INTEGER num_of_cntrl_devs The number of Control Devices defined. This
includes General Controllers and both the linear and
nonlinear Control Surfaces.
REAL cntrl_dev_values() Array of all the defined Control Device values
REAL lbc_set_sf The Load.BC Set Scale Factor
INTEGER top_pres The id of the Top Surface Pressure field
INTEGER bot_pres The id of the Bottom/Delta Surface Pressure field
INTEGER num_box A flag identifying if both the Top and the Bottom
Pressure
Output:
None.
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1789
AeroDynamic Utilities
Description:
This function gets the data for the specified Aerodynamic Pressure/Q vector.
Input:
STRING vector_name Name of the Pressure/Q vector to get
Output:
INTEGER coord_label The label of the coordinate frame
INTEGER xz_sym The label of the XZ Symmetry
INTEGER xy_sym The label of the XY Symmetry
REAL mach_num The Mach number
INTEGER num_of_rbm The number of Rigid Body Motions defined
REAL rbm_values() Array of all the defined Rigid Body Motion values
INTEGER num_of_cntrl_devs The number of Control Devices defined. This includes
General Controllers and both the linear and nonlinear
Control Surfaces.
REAL cntrl_dev_values() Array of all the defined Control Device values
REAL lbc_set_sf The Load.BC Set Scale Factor
INTEGER top_pres The id of the Top Surface Pressure field
INTEGER bot_pres The id of the Bottom/Delta Surface Pressure field
INTEGER num_box A flag identifying if both the Top and the Bottom
Pressure
Remarks:
None.
Example:
None.
1790 PCL Reference Manual
AeroDynamic Utilities
Description:
This function modifies the specified Aerodynamic Pressure/Q vector.
Input:
STRING vector_name Name of the Pressure/Q vector to modify
INTEGER coord_label The label of the coordinate frame
INTEGER xz_sym The label of the XZ Symmetry
INTEGER xy_sym The label of the XY Symmetry
REAL mach_num The Mach number
INTEGER num_of_rbm The number of Rigid Body Motions defined
REAL rbm_values() Array of all the defined Rigid Body Motion values
INTEGER num_of_cntrl_dev The number of Control Devices defined. This includes
s General Controllers and both the linear and nonlinear
Control Surfaces.
REAL cntrl_dev_values() Array of all the defined Control Device values
REAL lbc_set_sf The Load.BC Set Scale Factor
INTEGER top_pres The id of the Top Surface Pressure field
INTEGER bot_pres The id of the Bottom/Delta Surface Pressure field
INTEGER num_box A flag identifying if both the Top and the Bottom
Pressure
Output:
None.
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1791
AeroElastic Utilities
AeroElastic Utilities
This section explains the functions that are used in defining the Flight Loads elasticity and maintaining
it and its environment.
Description:
This function creates the Beam Splines given the information available on the SPLINE5 card.
Input:
STRING spline_name This value specifies the name of the Spline.
INTEGER spline_method This value specifies the spline method. (1=GENERAL,
2=DISPLACEMENT, 3=FORCE)
INTEGER dimension This value specifies the dimension value. (1=1D, 2=2D)
INTEGER num_struc_nodes This value specifies the number of Structural nodes
specified.
INTEGER struc_node_ids() This value specifies the array of Structural node ids.
INTEGER aero_type This value specifies the type of the Aero data. (1=BODY,
2=SURFACE)
INTEGER num_aero_elems This value specifies the number of Aero elements specified.
INTEGER aero_elem_ids() This value specifies the array of Aero element ids.
INTEGER bdy_surf_id This value specifies the ID of the Body/Surface that the
selected Aero elements belong to.
INTEGER ref_cid, This value specifies the Reference CID value.
REAL linear This value specifies the Linear Attach Flexibility value.
REAL x_rotation This value specifies the X-Rotation value.
REAL y_rotation This value specifies the Y-Rotation value.
REAL z_rotation This value specifies the Z-Rotation value.
REAL xy_tflex This value specifies the XY Torsion Flexibility value.
REAL zy_tflex This value specifies the ZY Torsion Flexibility value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an error.
Error Conditions:
1792 PCL Reference Manual
AeroElastic Utilities
3001003 %A% is an invalid Load Case Type. Must be Static or Time Dependent.
13000085 Cursor not open
13000117 The query specified has completed
14000001 LpGetHeapSpace: Allocated heapspace is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR
14000006 LpSublistType: In the list being used, the current geometry sublist is
unclassifiable
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable
14000010 LpSublistType: In the list being used, the current sublist does not match the
sublist filter
14000014 LpSublistNext: Attempt to proceed past last sublist in current list
14000015 LpSublistNext: End of current list has been reached
14000201 Invalid output string specified for call
26001010 Load/BC Definition %A% does not exist.
26002010 Load/BC Name is blank. Input a Load/BC Name.
26002011 Load/BC Name %A% is too long. Input 31 characters or less.
26002121 %I% is an invalid number of application regions for the specified Load/BC
definition.
26002134 The list %A% contains FEM or unknown GEOmetric entities. All the entities in
the application region(s) must be GEOmetric.
26002135 The list %A% contains GEOmetric or unknown FEM entities. All the entities in
the application region(s) must be FEM.
26002136 %A% is an invalid Geometry Filter. Must be Geometry or FEM.
26002200 There was no data input for this Load/BC Set.
26002201 %I% is an invalid number of input data fields for the specified Load/BC
definition.
26006001 Database error encountered: %I%. Call PDA Hotline.
1 This is am internal status condition. There is no corresponding status message in
the message database.
Chapter 8: FlightLoads Functions 1793
AeroElastic Utilities
Remarks:
None.
Example:
None.
Description:
This function modifies the Beam Splines given the information available on the SPLINE5 card.
Input:
STRING spline_name This value specifies the name of the Spline.
STRING new_spline_name This value specifies the new Spline name.
INTEGER spline_method This value specifies the spline method. (1=GENERAL,
2=DISPLACEMENT, 3=FORCE)
INTEGER dimension This value specifies the dimension value. (1=1D, 2=2D)
INTEGER num_struc_nodes This value specifies the number of Structural nodes specified.
INTEGER struc_node_ids() This value specifies the array of Structural node ids.
INTEGER aero_type This value specifies the type of the Aero data. (1=BODY,
2=SURFACE)
INTEGER num_aero_elems This value specifies the number of Aero elements specified.
INTEGER aero_elem_ids() This value specifies the array of Aero element ids.
INTEGER bdy_surf_id This value specifies the ID of the Body/Surface that the
selected Aero elements belong to.
INTEGER ref_cid, This value specifies the Reference CID value.
REAL linear This value specifies the Linear Attach Flexibility value.
REAL x_rotation This value specifies the X-Rotation value.
REAL y_rotation This value specifies the Y-Rotation value.
REAL z_rotation This value specifies the Z-Rotation value.
REAL xy_tflex This value specifies the XY Torsion Flexibility value.
REAL zy_tflex This value specifies the ZY Torsion Flexibility value.
Output:
1794 PCL Reference Manual
AeroElastic Utilities
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate an error.
Error Conditions:
3001003 %A% is an invalid Load Case Type. Must be Static or Time Dependent.
13000085 Cursor not open
13000103 No LBC was found
13000117 The query specified has completed
14000001 LpGetHeapSpace: Allocated heapspace is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter
14000014 LpSublistNext: Attempt to proceed past last sublist in current list
14000015 LpSublistNext: End of current list has been reached
14000201 Invalid output string specified for call
26001010 Load/BC Definition %A% does not exist.
26002011 Load/BC Name %A% is too long. Input 31 characters or less.
26002030 %A% already exists. Modify not permitted.
26002121 %I% is an invalid number of application regions for the specified Load/BC
definition.
26002134 The list %A% contains FEM or unknown GEOmetric entities. All the entities in the
application region(s) must be GEOmetric.
26002135 The list %A% contains GEOmetric or unknown FEM entities. All the entities in the
application region(s) must be FEM.
26002136 %A% is an invalid Geometry Filter. Must be Geometry or FEM.
26002200 There was no data input for this Load/BC Set.
26002201 %I% is an invalid number of input data fields for the specified Load/BC definition.
26002701 Load/BC set cannot be renamed to blank.
26002703 No existing Load/BC set is selected.
Chapter 8: FlightLoads Functions 1795
AeroElastic Utilities
Remarks:
None.
Example:
None
Description:
This function verifies that the list of element ids are all Aero elements.
Input:
STRING type Type of element property sets to be allowed
INTEGER num_elems Number of elements to be verified
INTEGER elem_ids() Array listing the element ids to be verified
Output:
INTEGER reg_id The id of the region the selected Aero elements belong to
INTEGER. <Return Value> 0 = Success; 1=Failure
Remarks:
None.
Example:
None
1796 PCL Reference Manual
AeroElastic Utilities
Description:
This function display the results of the Spline verification.
Input:
STRING splines() This value specifies the array of selected spline names.
STRING case_name This value specifies the structural load case name.
STRING subcase_name This value specifies the selected spline result condition.
STRING primary_name This value specifies the name of the result type. (Displacements
or Eigenvectors)
LOGICAL animate_active TRUE: if the results are to be animated; FALSE otherwise.
LOGICAL three_on TRUE: if a 3D animation is to be done; FALSE otherwise.
INTEGER num_frames This value specifies the number of frames to show if
animate_active is TRUE.
Output:
None.
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1797
AeroElastic Utilities
Description:
This function creates the Surface Splines given the information available on the SPLINE4 card.
Input:
STRING spline_name This value specifies the name of the Spline.
INTEGER spline_method This value specifies the spline method.
(1=GENERAL, 2=DISPLACEMENT, 3=FORCE)
INTEGER num_struc_nodes This value specifies the number of Structural nodes
specified.
INTEGER struc_node_ids() This value specifies the array of Structural node ids.
INTEGER num_aero_elems This value specifies the number of Aero elements
specified.
INTEGER aero_elem_ids() This value specifies the array of Aero element ids.
INTEGER surf_id This value specifies the ID of the Surface that the
selected Aero elements belong to.
REAL linear_attach_flex This value specifies the Linear Attach Flexibility
value.
INTEGER type This value specifies the type.
(1=HARDER_DESM, 2=THIN_PLATE,
3=FINITE_PLATE)
INTEGER x_axis This value specifies the number of X-axis elements.
INTEGER y_axis This value specifies the number of Y-axis elements.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate an
error.
Error Conditions:
3001003 %A% is an invalid Load Case Type. Must be Static or Time Dependent.
13000085 Cursor not open
13000117 The query specified has completed
14000001 LpGetHeapSpace: Allocated heapspace is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
1798 PCL Reference Manual
AeroElastic Utilities
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR
14000006 LpSublistType: In the list being used, the current geometry sublist is
unclassifiable
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable
14000010 LpSublistType: In the list being used, the current sublist does not match the
sublist filter
14000014 LpSublistNext: Attempt to proceed past last sublist in current list
14000015 LpSublistNext: End of current list has been reached
14000201 Invalid output string specified for call
26001010 Load/BC Definition %A% does not exist.
26002010 Load/BC Name is blank. Input a Load/BC Name.
26002011 Load/BC Name %A% is too long. Input 31 characters or less.
26002121 %I% is an invalid number of application regions for the specified Load/BC
definition.
26002134 The list %A% contains FEM or unknown GEOmetric entities. All the entities
in the application region(s) must be GEOmetric.
26002135 The list %A% contains GEOmetric or unknown FEM entities. All the entities
in the application region(s) must be FEM.
26002136 %A% is an invalid Geometry Filter. Must be Geometry or FEM.
26002200 There was no data input for this Load/BC Set.
26002201 %I% is an invalid number of input data fields for the specified Load/BC
definition.
26006001 Database error encountered: %I%. Call PDA Hotline.
1 This is am internal status condition. There is no corresponding status message
in the message database.
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1799
AeroElastic Utilities
Description:
This function modifies the Surface Splines given the information available on the SPLINE4 card.
Input:
STRING spline_name This value specifies the name of the Spline.
STRING new_spline_name This value specifies the new Spline name.
INTEGER spline_method This value specifies the spline method. (1=GENERAL,
2=DISPLACEMENT, 3=FORCE)
INTEGER num_struc_nodes This value specifies the number of Structural nodes specified.
INTEGER struc_node_ids() This value specifies the array of Structural node ids.
INTEGER num_aero_elems This value specifies the number of Aero elements specified.
INTEGER aero_elem_ids() This value specifies the array of Aero element ids.
INTEGER surf_id This value specifies the ID of the Surface that the selected Aero
elements belong to.
REAL linear_attach_flex This value specifies the Linear Attach Flexibility value.
INTEGER type This value specifies the type. (1=HARDER_DESM,
2=THIN_PLATE, 3=FINITE_PLATE)
INTEGER x_axis This value specifies the number of X-axis elements.
INTEGER y_axis This value specifies the number of Y-axis elements.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate an error.
Error Conditions:
3001003 %A% is an invalid Load Case Type. Must be Static or Time Dependent.
13000085 Cursor not open
13000103 No LBC was found
13000117 The query specified has completed
14000001 LpGetHeapSpace: Allocated heapspace is exhausted
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR
1800 PCL Reference Manual
AeroElastic Utilities
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter
14000014 LpSublistNext: Attempt to proceed past last sublist in current list
14000015 LpSublistNext: End of current list has been reached
14000201 Invalid output string specified for call
26001010 Load/BC Definition %A% does not exist.
26002011 Load/BC Name %A% is too long. Input 31 characters or less.
26002030 %A% already exists. Modify not permitted.
26002121 %I% is an invalid number of application regions for the specified Load/BC definition.
26002134 The list %A% contains FEM or unknown GEOmetric entities. All the entities in the
application region(s) must be GEOmetric.
26002135 The list %A% contains GEOmetric or unknown FEM entities. All the entities in the
application region(s) must be FEM.
26002136 %A% is an invalid Geometry Filter. Must be Geometry or FEM.
26002200 There was no data input for this Load/BC Set.
26002201 %I% is an invalid number of input data fields for the specified Load/BC definition.
26002701 Load/BC set cannot be renamed to blank.
26002703 No existing Load/BC set is selected.
26006001 Database error encountered: %I%. Call PDA Hotline.
26006004 Dynamic memory allocation error encountered.
1 This is am internal status condition. There is no corresponding status message in the
message database.
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1801
Loadsbrowser Utilities
Loadsbrowser Utilities
This section explains the functions that are used in defining the Flight Loads loadsbrowser and
maintianing it and its environment.
Description:
This function writes forces cards from specified data source.
Input:
INTEGER rc_ids() This value specifies the result case definition arrray:
res_ids(i,1) = Loadcase Id
res_ids(i,2) = Subcase Id
res_ids(i,5) = Layer Id
STRING load_set_list This value specifies the list of load set ids.
STRING output_file This value specifies the output file name.
LOGICAL write_nodes TRUE: GRID cards will be written; FALSE otherwise.
Output:
None.
Remarks:
None.
Example:
None.
Description:
This function plots the running loads.
Input :
num_regions_p INTEGER Number of selected regions (-1=Region Chain,
0=Selected Entities, n=no. of regions)
region_names_p[]() STRING Names of the selected regions or region chain, or picklist
of entities
output_cf_pick[] STRING Coord frame if entities selected
comp_plot_p() LOGICAL Components to plot
lbc_values_num_p INTEGER Number of LBCs selected
lbc_values_p[]() STRING Names of the LBCs selected
case_values_num_p INTEGER Number of loadcases selected
case_values_p[]() STRING Names of the loadcases selected
force_results() INTEGER Force results selected
moment_results() INTEGER Moment results selected
conv_values_p[] STRING Names of the algorithms
integ_axis_p[] STRING Whether range is MANUAL or AUTO.
minval_value_p REAL Minimum range value specified.
maxval_value_p REAL Maximum range value specified.
eval_pts_p INTEGER Number of evaluation points
mult_curve_p[] STRING "Multiple curve plotting" option
prev_created_p[] STRING "Previously created" option
file_name_p[] STRING Output text file name
Output :
None.
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1803
Loadsbrowser Utilities
Description:
This function plots the sum of loads.
Input:
unum_regions INTEGER Number of entities (-1=Entire Model, 0=Selected
Entities, n=no. of regions)
regions[]() STRING Entities (picklist or regions for n!= 0)
lbc_values_num INTEGER Number of lbcs selected
lbc_values[]() STRING Names of lbcs selected
case_values_num INTEGER Number of loadcases selected
case_values[]() STRING Names of loadcases selected
force_results() INTEGER Force results selected
moment_results() INTEGER Moment results selected
comp_sum() LOGICAL Components to sum (1-6)
algorithm[] STRING Pressure algorithms selected
ref_pnt[] STRING Reference point for sum (picklist)
output_cf_pick[] STRING Coordinate frame (picklist)
sum_method[] STRING Summation side: given or opposite plane
Output:
None.
Remarks:
None.
Example:
None.
1804 PCL Reference Manual
Loadsbrowser Utilities
Description:
This function performs load summation calculations and saves in load cases
Input:
lcase STRING Load case to create equiv vectors for
storage_lcase STRING Load case in which to store equiv vectors
output_cf_pick STRING Coord frame for equivalent vectors
app_entities STRING Entity picklist to consider for summation
ref_pnt STRING Point about which to sum loads
Output:
None.
Remarks:
None.
Description:
This function creates a new user data instance of a region.
Input:
Name STRING[] Name of region
cid INTEGER Coord frame id
groups STRING[]() Groups for region
num_groups INTEGER Number of groups for region
Output:
None.
Chapter 8: FlightLoads Functions 1805
Loadsbrowser Utilities
Remarks:
None.
Example:
None.
Description:
This function modifies a region in the database. If the region is referenced by a region
chain, the chain is also updated.
Input:
old_name STRING[] Current region name
new_name STRING[] Desired region name
cid INTEGER Coord frame id
groups STRING[]() Group names for region
num_groups INTEGER Number of groups for region
Output:
None.
Remarks:
None.
Example:
None.
load_tools_region.delete (names )
Description:
This function deletes a user data instance of a region.
Input:
names STRING[]() regions to delete
Output:
None.
1806 PCL Reference Manual
Loadsbrowser Utilities
Remarks:
If the region name does not exist this function does nothing and returns a success.
Example:
None.
Description:
This function creates a new region chain.
Input:
name STRING[] Name of instance for chain
regions STRING[]() Regions comprising the chain
num_regions INTEGER Number of region comprising the chain
Output:
None.
Remarks:
None.
Example:
None.
Chapter 8: FlightLoads Functions 1807
Loadsbrowser Utilities
Description:
This function enables you to modify a region chain stored in the database. Any of the defining data
(including name) may be modified.
Input:
old_name STRING[] Existing chain name
new_name STRING[] Desired chain name
regions STRING[]() Regions for chain
num_regions INTEGER Number of regions for chain
Output:
None.
Remarks:
None.
Example:
None.
load_tools_chain.delete ( names )
Description:
This function deletes a region chain.
Input:
names STRING[]() Name of chain.
Output:
None.
Remarks:
If the region name does not exist this function does nothing and returns a success.
Example:
None.
1808 PCL Reference Manual
Loadsbrowser Utilities
Chapter 9: Preference Functions
PCL Reference Manual
9 Preference Functions
Introduction 1810
Analysis Preferences 1811
Global Preferences 1814
Graphics Preferences 1827
Report Preferences 1856
Geometry Preferences 1859
Finite Element Preferences 1863
1810 PCL Reference Manual
Introduction
Introduction
This chapter documents functions that are used to control some of the settings or preferences used by
many of the other forms used in Patran. Many of these functions are used in the implementation of the
Preferences menu bar item.
This chapter presents function descriptions in seven separate sections:
Analysis Preferences This section is used to describe some of the functions used to
govern some of the preferences used with the analysis of a model.
Global Preferences This section is used to describe some of the functions used to
govern some of the preferences used to control the global
behavior of Patran.
Graphics Preferences This section is used to describe some of the functions used to
govern some of the preferences used to control how graphics are
displayed to the user.
Report Preferences This section is used to describe some of the functions used to
govern some of the preferences used to control the generation of
reports.
Geometry Preferences This section is used to describe some of the functions used to
govern some of the preferences used to define how geometry is
interpreted.
Finite Element Preferences This section is used to describe some of the functions used to
govern some of the preferences used with finite element model
elements.
Chapter 9: Preference Functions 1811
Analysis Preferences
Analysis Preferences
This section is used to describe some of the functions used to govern some of the preferences used with
the analysis of a model.
Description:
This function changes the analysis preferences of the current database.
Input:
STRING analysis_code[31] This value specifies the analysis code or the name of the
solver to be used. See the remarks below for more
information.
STRING analysis_type[31] This value specifies the type of analysis provided by the
solver. See the remarks below for more information.
STRING input_file_suffix This value specifies the default suffix for the chosen analysis
[4] codes input files. See the remarks below for more
information.
STRING output_file_suffi This value specifies the default suffix for output files from
x[4] the chosen analysis code. See the remarks below for more
information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form that is displayed when Preferences,
Analysis... is selected from the menu bar.
Many of the forms and menus in Patran are dependent upon the settings represented by the input values
analysis_code and analysis_type. Changing these values can modify the contents of many of these forms
and menus. Calling the function ui_wid_refresh() after this function is called will update any forms or
menus that are currently displayed and make use of the analysis code and type values.
In previous releases of Patran, analysis preferences were changed with a function sequence as follows:
sys_library( add, * )
output_file_suffix )
1812 PCL Reference Manual
Analysis Preferences
sys_library( remove, * )
This sequence will still work but is obsolete and all three of these calls should be replaced with the new
PCL function described above.
Another obsolete function which might appear in old Patran session or journal files and should be
replaced is:
uil_pref_setcode.save_anal_values ( anal_code, anal_type,@
input_file_suffix, output_file_suffix )
The input values analysis_code, analysis_type can have the following values. Note that the value allowed
for the analysis_type is dependent on the value used for the analysis_code. The default values for the
input value input_file_suffix and output_file_suffix are listed as well:
Chapter 9: Preference Functions 1813
Analysis Preferences
Example:
Global Preferences
This section is used to describe some of the functions used to govern some of the preferences used to
control the global behavior of Patran
.
Description:
This function will get geometry preference settings.
Input:
None.
Output:
INTEGER default_coord_frame This value returns the identifier value for the default
coordinate frame.
REAL geometric_tolerance This value returns the relative geometric tolerance.
INTEGER working_plane This value returns the value defining the default working
plane relative to the default coordinate frame.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form that is displayed when Preferences, Global...
is selected from the menu bar.
Example:
Description:
This function will get geometry preference settings.
Input:
None.
Output:
INTEGER default_coord_frame This value returns the identifier value for the default
coordinate frame.
REAL geometric_tolerance This value returns the relative geometric tolerance.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Example:
Description:
This function will set geometry preference settings.
Input:
INTEGER default_coord_frame This value specifies the identifier value for the default
coordinate frame.
REAL geometric_tolerance This value specifies the relative geometric tolerance.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
1816 PCL Reference Manual
Global Preferences
Remarks:
The geometric tolerance is set to 0.005 for the default value. This value needs to be changed depending
on the model size. Users are advised to set this value so that CAD models and IGES geometry are
imported properly. The suggested geometry tolerance is 0.005 times the model size.
Example:
Description:
This function will set geometry preference settings.
Input:
INTEGER default_coord_frame This value specifies the identifier value for the default
coordinate frame.
REAL geometric_tolerance This value specifies the relative geometric tolerance.
INTEGER working_plane This value specifies the value defining the default working
plane relative to the default coordinate frame. Valid values
are: 1 = to place the working plane along the X, Y axis, 2 =
the Y, Z axis, and 3 = the X, Z axis.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form that is displayed when Preferences, Global...
is selected from the menu bar.
The geometric tolerance is set to 0.005 for the default value. This value needs to be changed depending
on the model size. Users are advised to set this value so that CAD models and IGES geometry are
imported properly. The suggested geometry tolerance is 0.005 times the model size.
Example:
Description:
This function will get global preference settings.
Input:
None.
Output:
LOGICAL confirm This value returns nothing as it is currently not used.
INTEGER warning_message This value returns the status for the warning message option.
This value will be set to: 1 = no warnings, 2 = ring the bell, and
3 = present a warning in a popup form.
REAL global_tolerance This value returns the global model tolerance.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form that is displayed when Preferences, Global...
is selected from the menu bar.
Example:
Description:
This function will set global preference settings.
Input:
LOGICAL confirm This value specifies nothing as it is currently not used.
INTEGER warning_message This value specifies the status for the warning message option.
This value will be set to: 1 = no warnings, 2 = ring the bell, and 3
= present a warning in a popup form.
REAL global_tolerance This value specifies the global model tolerance.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and
a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form that is displayed when Preferences, Global...
is selected from the menu bar.
Example:
Description:
This function will get the value of the named integer preference.
Input:
STRING preference_name[] This value specifies the name of the preference from which the
output value integer_value will be retrieved This name can be of
any length or value.
Output:
INTEGER integer_value This value returns the integer setting for the preference.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
12002001 The environment preference was not found.
12002002 The environment preference is of the wrong datatype.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started
up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked
list in memory. The contents of this linked list are saved and restored through the settings.pcl file
mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Description:
This function will get the value of the named logical preference.
Input:
STRING preference_name[] This value specifies the name of the preference from which the
output value logical_value will be retrieved. This name can be
of any length.
Output:
LOGICAL logical_value This value returns the logical setting for the preference.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
12002001 The environment preference was not found.
12002002 The environment preference is of the wrong datatype.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started
up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked
list in memory. The contents of this linked list are saved and restored through the settings.pcl file
mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Descriptio:
This function will get the value of the named real preference.
Input:
STRING preference_name[] This value specifies the name of the preference from which
the output value real_value will be retrieved. This name can
be of any length.
Output:
REAL real_value This value returns the real setting for the preference.
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
12002001 The environment preference was not found.
12002002 The environment preference is of the wrong datatype.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started
up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked
list in memory. The contents of this linked list are saved and restored through the settings.pcl file
mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Description:
This function will get the value of the named string preference.
Input:
STRING preference_name[] This value specifies the name of the preference from
which the output value string_value will be retrieved.
This name can be of any length.
Output:
STRING string_value[] This value returns the string setting for the preference.
Because this is not a VIRTUAL string and no storage
space is allocated for this string by this function, it must
be created big enough to contain the entire named string
preference value or an error will occur.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
12002001 The environment preference was not found.
12002002 The environment preference is of the wrong datatype.
12002003 The string buffer is too small for the preference.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started
up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked
list in memory. The contents of this linked list are saved and restored through the settings.pcl file
mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Description:
This function will set the value of the named integer preference.
Input:
STRING preference_name[] This value specifies the name of the preference under
which the input value integer_value will be stored.
This name can be of any length.
INTEGER integer_value This value specifies the integer setting for the named
preference.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
12002002 The environment preference is of the wrong datatype.
12002004 An error occurred creating an environment preference.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started
up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked
list in memory. The contents of this linked list are saved and restored through the settings.pcl file
mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Description:
This function will set the value of the named logical preference.
Input:
STRING preference_name[] This value specifies the name of the preference
under which the input value logical_value will be
stored. This name can be of any length.
LOGICAL logical_value This value specifies the logical setting for the
named preference.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
12002002 The environment preference is of the wrong datatype.
12002004 An error occurred creating an environment preference.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started
up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked
list in memory. The contents of this linked list are saved and restored through the settings.pcl file
mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Description:
This function will set the value of the named real preference.
Input:
STRING preference_name[] This value specifies the name of the preference under
which the input value real_value will be stored. This
name can be of any length.
REAL real_value This value specifies the real setting for the named
preference.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
12002002 The environment preference is of the wrong datatype.
12002004 An error occurred creating an environment preference.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started
up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked
list in memory. The contents of this linked list are saved and restored through the settings.pcl file
mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Description:
This function will set the value of the named real preference.
Input:
STRING preference_name[] This value specifies the name of the preference under
which the input value string_value will be stored. This
name can be of any length.
STRING string_value[] This value specifies the string setting for the named
preference and can be of any length.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
12002002 The environment preference is of the wrong datatype.
12002004 An error occurred creating an environment preference.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started
up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked
list in memory. The contents of this linked list are saved and restored through the settings.pcl file
mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Graphics Preferences
This section is used to describe some of the functions used to govern some of the preferences used to
control how graphics are displayed to the user.
bar_elem_color (color_value)
Description:
This function is used to set the color value used for the display of bar type finite element model
entities and labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks
below for more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
bar_elem_label (label_status)
Description:
This function sets a status value that indicates if bar type finite element model entity labels
will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that bar type
finite element model entity labels will be displayed,
and FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
body_color (color_value)
Description:
This function is used to set the color value used for the display of bodies and body labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks
below for more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Chapter 9: Preference Functions 1829
Graphics Preferences
Example:
body_label (label_status)
Description:
This function sets a status value that indicates if body labels will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that entity labels for
bodies will be displayed, and FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
curve_color (color_value)
Description:
This function is used to set the color value used for the display of curves and curve labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks below for more
information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
Chapter 9: Preference Functions 1831
Graphics Preferences
curve_label (label_status)
Description
:
This function sets a status value that indicates if curve labels will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that entity labels for
curves will be displayed, and FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
Please see curve_label (p. 1383) in the PCL Reference Manual Examples.
display_deformations (label_status)
Description
:
This function sets a status value that indicates if deformation results will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that deformation
results will be displayed.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
1832 PCL Reference Manual
Graphics Preferences
This function is used in the implementation of the form displayed when the Results... selection is
picked from the Display pull down menu.
Example:
display_fa_vectors (label_status)
Descriptio:
This function sets a status value that indicates if functional assignment field vectors will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that functional
assignment field vectors will be displayed.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully
and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the Load/BC/Elem. Props...
selection is picked from the Display pull down menu.
Example:
display_result_vectors (label_status)
Description
:
This function sets a status value that indicates if result vectors will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that functional
assignment field vectors will be displayed.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Chapter 9: Preference Functions 1833
Graphics Preferences
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the Results... selection is
picked from the Display pull down menu.
Example:
hex_elem_color (color_value)
Description
:
This function is used to set the color value used for the display of hexagonal finite element model
entities and labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks below
for more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
hex_elem_label (label_status)
Description:
This function sets a status value that indicates if hexagonal finite element model entity labels
will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that
hexagonal finite element model entity labels will be
displayed, and FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
mpc_color (color_value)
Descriptio:
This function is used to set the color value used for the display of multi-point constraint labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks below for
more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
mpc_label (label_status)
Description:
This function sets a status value that indicates if multi-point constraint labels will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that multiple
point constraint labels will be displayed, and FALSE
otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
node_color (color_value)
Description:
This function is used to set the color value used for the display of finite element model nodes and node
labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks below for
more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Chapter 9: Preference Functions 1837
Graphics Preferences
Example:
node_label (label_status)
Description:
This function sets a status value that indicates if node labels will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that node labels
will be displayed, and FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
point_elem_color (color_value)
Description:
This function is used to set the color value used for the display of point elements and
point element labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks below
for more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
point_color (color_value)
Description:
This function is used to set the color value used for the display of geometric points and geometric
point labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks below for
more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
point_elem_label (label_status)
Description:
This function sets a status value that indicates if point element labels will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that point element labels
will be displayed, and FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
point_label (label_status)
Description:
This function sets a status value that indicates if point labels will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that point labels
will be displayed, and FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Chapter 9: Preference Functions 1841
Graphics Preferences
Example:
Description:
This function sets the graphics preference parameters.
Input:
LOGICAL label_control(20) This value specifies which values from the inputs for
this function will be set in the database. The offsets in
the array correspond to the arguments listed below.
Setting the value at an offset in this array to TRUE will
cause the corresponding input argument value to be set
in the database.
INTEGER display_method This value specifies the display method setting.
INTEGER primary_color This value specifies the primary color.
INTEGER secondary_color This value specifies the secondary color.
INTEGER error_color This value specifies the error color.
LOGICAL extend This value specifies, when set to TRUE, that the
autoextend setting is turned on.
LOGICAL fit_view This value specifies, when set to TRUE, that the fit
view setting is turned on.
LOGICAL center This value specifies, when set to TRUE, that the
autocenter setting is turned on.
LOGICAL hardware_renderin This value specifies, when set to TRUE, the use of
g hardware for display rendering.
LOGICAL anti_alias This value specifies, when set to TRUE, that the anti
alias setting is turned on.
LOGICAL three_d_vector This value specifies, when set to TRUE, that 3-D
vectors be displayed.
LOGICAL result_title This value specifies, when set to TRUE, that result
titles be displayed.
1842 PCL Reference Manual
Graphics Preferences
LOGICAL symmetric_light This value specifies, when set to TRUE, that the
symmetric light flag setting is turned on.
INTEGER primary_marker This value specifies the primary marker setting.
INTEGER secondary_marker This value specifies the secondary marker setting.
INTEGER marker_color This value specifies the color used to display markers.
INTEGER marker_size This value specifies the marker size.
INTEGER point_marker_size This value specifies the point marker size.
INTEGER node_marker_size This value specifies the node marker size.
INTEGER results_format This value specifies the format used to display labels.
INTEGER significant_figures This value specifies the number of significant figures
used to display results.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
None.
Example:
quad_elem_color (color_value)
Description
:
This function is used to set the color value used for the display of quadrilateral finite element model
entities and entity labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks below for
more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
The input value color_value can have the following values:
Example:
quad_elem_label (label_status)
Description:
This function sets a status value that indicates if quadrilateral finite element model entity labels will be
displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that
quadrilateral element labels will be displayed, and
FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
renderstyle (render_style)
Description:
This function sets the style used to render the display of entities in a viewport.
Input:
STRING style[31] This value specifies the render style used. If this value
is set to nothing or , the default Wireframe render
style will be used. See the remarks below for more
information.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change
in status or an error.
Error Conditions:
None.
Remarks:
The input value render_style will accept the following case sensitive values:
Wireframe Wireframe/Accurate
Hidden Line Hidden Line/Accurate
Shaded/Flat Shaded/Smooth
Fringe/Flat Fringe/Smooth
Fringe/Flat/Lighted Fringe/Smooth/Lighted
Element Fill Element Fill/Accurate
Example:
shade_color (color_value)
Description:
This function is used to set the color value used for the display of shadows.
Input:
INTEGER color_value This value specifies the color used. See the remarks
below for more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
solid_color (color_value)
Description:
This function is used to set the color value used for the display of solid objects.
Input:
INTEGER color_value This value specifies the color used. See the remarks
below for more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
solid_label (label_status)
Description:
This function sets a status value that indicates if solid labels will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that solid labels
will be displayed, and FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
surface_color (color_value)
Description:
This function is used to set the color value used for the display of surfaces and surface labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks below for
more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Chapter 9: Preference Functions 1849
Graphics Preferences
Example:
surface_label (label_status)
Description:
This function sets a status value that indicates if surface labels will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that surface labels will be
displayed, and FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
tet_elem_color (color_value)
Description:
This function is used to set the color value used for the display of tetrahedral finite element model entities
and labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks below
for more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
tet_elem_label (label_status)
Description:
This function sets a status value that indicates if tetrahedral finite element model entity labels
will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that
tetrahedral mesh labels will be displayed, and
FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
tri_elem_color (color_value)
Description:
This function is used to set the color value used for the display of triangular finite element
model entities and labels.
Input:
INTEGER color_value This value specifies the color used. See the
remarks below for more information.
Output:
None.
Error Conditions:
None.
1852 PCL Reference Manual
Graphics Preferences
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
tri_elem_label (label_status)
Description:
This function sets a status value that indicates if triangular finite element model entity labels will be
displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that triangular
mesh labels will be displayed, and FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Chapter 9: Preference Functions 1853
Graphics Preferences
Example:
trim_surface_color (color_value)
Description:
This function is used to set the color value used for the display of trimmed surfaces and trimmed
surface labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks
below for more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
trim_surface_label (label_status)
Description:
This function sets a status value that indicates if trimmed surface labels will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that trimmed
surface labels will be displayed, and FALSE
otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
wedge_elem_color (color_value)
Description:
This function is used to set the color value used for the display of wedge shaped finite element model
entities and labels.
Input:
INTEGER color_value This value specifies the color used. See the remarks
below for more information.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Chapter 9: Preference Functions 1855
Graphics Preferences
Example:
wedge_elem_label (label_status)
Description:
This function sets a status value that indicates if wedge shaped finite element model entity
labels will be displayed.
Input:
LOGICAL label_status This value specifies, when set to TRUE, that
wedge element labels will be displayed, and
FALSE otherwise.
Output:
None.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the
Entity/Color/Label/Render... selection is picked from the Display pull down menu.
Example:
Report Preferences
This section is used to describe some of the functions used to govern some of the preferences used to
control the generation of reports.
Description:
This function gets the parameters used to format tabular textual results reports.
Input:
None.
Output:
INTEGER real_numbers This value returns the real number switch status.
INTEGER float_field_width This value returns the field width used for listing
floating point numbers.
INTEGER float_decimal This value returns the number of values shown after
the decimal point of a floating point number.
INTEGER sci_field_width This value returns the field width used to list
numbers in scientific notation.
INTEGER sci_decimal This value returns the number of values shown after
the decimal point of a number in scientific notation.
INTEGER integer_field_width This value returns the field width used to list
integers.
INTEGER number_spacing This value specifies the number of spaces placed
between numerical fields.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a
change in status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the Report... selection is picked
from the Preferences pull down menu.
Example:
Description:
This function sets the parameters used to format tabular textual results reports.
Input:
INTEGER real_numbers This value specifies the real number switch
status. The floating point format will be used if
this value is set to 1 and the scientific notation
format will be used if this value is set to 2.
INTEGER float_field_width This value specifies the field width used for
listing floating point numbers. This value can
range from 3 to 12.
INTEGER float_decimal This value specifies the number of values
shown after the decimal point of a floating point
number. This value can range from 0 to 11.
INTEGER sci_field_width This value specifies the field width used to list
numbers in scientific notation. This value can
range from 6 to 12.
INTEGER sci_decimal This value specifies the number of values
shown after the decimal point of a number in
scientific notation. This value can range from 1
to 7.
INTEGER integer_field_width This value returns the field width used to list
integers. This value can range from 1 to 12.
INTEGER number_spacing This value specifies the number of spaces
placed between numerical fields. This value can
range from 1 to 20.
Output:
INTEGER <Return Value> This function returns a value of 0 when
executed successfully and a non zero value to
indicate a change in status or an error.
Error Conditions:
None.
1858 PCL Reference Manual
Report Preferences
Remarks:
This function is used in the implementation of the form displayed when the Report... selection is picked
from the Preferences pull down menu.
Example:
Geometry Preferences
This section is used to describe some of the functions used to govern some of the preferences used to
define how geometry is interpreted.
Description:
This function gets the geometric preference values in the database.
Input:
None.
Output:
LOGICAL hpat_parametrization This value returns a status setting used to select the
parameter convention for hyperpatches. When this value
is set to TRUE, hyperpatches will not necessarily use the
same parameters as used with Patran 2.5. When this value
Remarks:
This function is used in the implementation of the form displayed when the Report... selection is picked
from the Preferences pull down menu.
Example:
pref_geometry_set_v1 (hpat_parametrization,
nurbs_acceleration,
geometry_convention)
Description:
This function sets the geometric preference values in the database.
Input:
LOGICAL hpat_parametrization This value specifies, when set to TRUE, that hyperpatches
will not necessarily use the same parameters as used with
Patran 2.5. Setting this value to TRUE will indicate that
the Patran convention will be used with solid origin
locations. Setting this value to FALSE will ensure
compatibility with models created using Patran 2.5.
LOGICAL nurbs_acceleration This value specifies, when set to TRUE, that nurbs curves
and surfaces will be evaluated using specially designed
evaluators which are optimized for speed. These
optimized evaluators should not be used with higher order
curves and surfaces as they tend to be unstable under those
conditions. When this value is set to FALSE another kind
of evaluator is used, one that is stable under all conditions.
LOGICAL geometry_convention This value specifies, when set to TRUE, that geometry
will be represented using the Patran 2.5 convention.
Setting this value to TRUE will ensure compatibility with
models created using Patran 2.5. When this value is set to
FALSE, the Patran convention will be used.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the Report... selection is picked
from the Preferences pull down menu.
Example:
1862 PCL Reference Manual
Geometry Preferences
pref_fem_get (minimum_angle)
Description:
This function gets the finite element model minimum angle value from the database.
Input:
Output:
REAL mininimum_angle The value returns the mesh/edges snap angle in degrees.
This angle controls the automatic snapping of nodes to
geometry edge slope discontinuities during seeding,
meshing and sweeping operations. These operations will
place nodes at all edge slope discontinuities greater than
the angle returned by this value.
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Remarks:
This function is used in the implementation of the form displayed when the Finite Element... selection
is picked from the Preferences pull down menu.
Example:
pref_fem_set (minimum_angle)
Description:
This function sets the finite element model minimum angle value in the database.
Input:
REAL mininimum_angle The value specifies the mesh/edges snap angle in
degrees. This angle controls the automatic snapping of
nodes to geometry edge slope discontinuities during
seeding, meshing and sweeping operations. These
operations will place nodes at all edge slope
discontinuities greater than the angle specified by this
value.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed
successfully and a non zero value to indicate a change in
status or an error.
Error Conditions:
None.
Remarks:
If changing the input value minimum_angle changes the number of locations requiring nodes on any edge
with a mesh seed, a popup form will be used to request permission to adjust the seed locations on that
edge unless the number of locations requiring nodes changes to zero. If the number of locations requiring
nodes changes to zero, the existing seeds will not be modified.
This function is used in the implementation of the form displayed when the Finite Element... selection
is picked from the Preferences pull down menu.
Example:
Introduction 1866
Geometry Application Preference (Chapter 3) 1867
Finite Element Modeling Preference (Chapter 4) 1869
Function Assignments Application Preference (Chapter 5) 1870
Results Postprocessing Application Preference (Chapter 6) 1872
XY Plotting Application Preference (Chapter 7) 1873
Preference Application Preference (Chapter 8) 1874
FlightLoads Preference (Chapter 9) 1875
1866 PCL Reference Manual
Introduction
Introduction
This chapter of the PCL Reference Manual document contains a listing of all the functions that have been
found to contain some sort of error in Chapters 1 through 8 of the documentation that could effect the use
of the function. The routine name is given along with a description of what issues were found, a
resolution to the issue, and the original function information. Where applicable the new function
information is also given. All spelling, spacing, and grammar errors have been fixed and in those
instances where the issues are only with the documentation of the function, a change has been made in
the new release of the PCL Reference Manual.
Chapter 10: Broken, Obsolete, Modified and New Functions 1867
Geometry Application Preference (Chapter 3)
Input
STRING output_ids[] The Curve ID List. If blank, 0, or #, Database will assign Curve IDs
sequentially
Input:
STRING output_ids[] The Curve ID List. If blank, 0, or #, Database will assign Curve IDs
sequentially
ga_groups_create (group_name)
Input
STRING group_name[31] This value specifies the name of the group to create.
Output:
INTEGER <Return Value> This function returns a value of 0 when executed successfully and a
non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
Output
None.
Output
elementprops_show Issue: When running this call Patran outputs the error
message Invalid datatype to built-in function. Arg#3.
Type: Modified
Resolution: Changed the variable GRP_NAMES from
type string to type string array.
Input
Table
Marker Plot
Vector Plot
Scalar Plot
Input
Table
Marker Plot
Vector Plot
Scalar Plot
Output
Output
Output
Output
display_deformations (flag)
Output
None.
display_deformations (flag)
Output
11 Status Messages
Introduction 1878
Status Conditions 1879
1878 PCL Reference Manual
Introduction
Introduction
This chapter lists all of the error condition messages that can be retrieved with the use of the status
message functions: msg_get_string(), user_message(), msg_to_form(), and msg_to_text().
Chapter 11: Status Messages 1879
Introduction
Status Conditions
I/O and Import Status Conditions, 1880
Analytical Solids Modeling Status Conditions, 1887
Finite Element Model Status Conditions, 1900
Load Case Status Conditions, 1927
Results Status Conditions, 1929
Application Interface Status Conditions, 1949
PCL Status Conditions, 1997
Core Status Conditions, 2002
XY Status Conditions, 2004
Group Status Conditions, 2007
Preference Status Conditions, 2015
Database Status Conditions, 2016
List Processor Status Conditions, 2024
Graphics Manager Status Conditions, 2038
Application Status Conditions, 2044
List Manager Status Conditions, 2045
ID Dispenser Status Conditions, 2046
Mesher Status Conditions, 2047
IGES Status Conditions, 2051
Unigraphics Status Conditions, 2051
Session File Status Conditions, 2057
Command Line Interface Status Conditions, 2058
NOODL Status Conditions, 2058
Neutral File Status Conditions, 2059
Loads and Boundary Conditions Status Conditions, 2065
Materials Status Conditions, 2070
Element Property Status Conditions, 2079
Fields Status Conditions, 2083
Event ManagerStatus Conditions, 2090
Security Status Conditions, 2091
Meshing Finite Elements Status Conditions, 2095
Automesher Status Conditions, 2099
Automesher Status Conditions, 2099
1880 PCL Reference Manual
Introduction
0 Successful Completion
1 Not owner
2 No such file or directory
3 No such process
4 Interrupted system call
5 I/O error
6 No such device or address
7 Arg list too long
8 Exec format error
9 Bad file number
10 No child processes
Chapter 11: Status Messages 1881
Introduction
20005
No IGES entities were imported. Review the Patran supported IGES Geometric
Entity list and the status of the entity filters under "IGES Entity Options". Preview
the IGES file to review file content.
Chapter 11: Status Messages 1885
Introduction
20006
No Patran entities were created from the IGES file import.
20007
No Patran entities were exported.
20008
No IGES entities were created from the Patran IGES file export.
20009 The Pro/ENGINEER file naming convention for a Part file uses ".prt" for the
suffix. The invalid Part file name entered is "%A%" Enter a ".prt" file.
20010 The Pro/ENGINEER file naming convention for an Assembly file uses ".asm" for
the suffix. The invalid Assembly file name entered is "%A%" Enter a ".asm" file.
20011 No Pro/ENGINEER geometry was imported.
20012
No Patran geometry was created from the Pro/ENGINEER Model Access.
20013 Pro/ENGINEER Initiated.
20014 Pro/ENGINEER Terminated.
20015 Accessing Pro/ENGINEER Part File %A% ...
20016 Accessing Pro/ENGINEER Assembly File %A% ...
20017
Accessing Patran ProENGINEER Access Primitive Geometry File %A% ...
20018
The Patran ProENGINEER Access file naming convention for a Primitive
Geometry file uses ".geo" for the suffix. The invalid Primitive Geometry file name
entered is "%A%" Enter a ".geo" file.
20019
Patran ProENGINEER Access Primitive Geometry File %A% has been saved.
20020 No Unigraphics geometry was imported.
20021
No Patran geometry was created from the Unigraphics Model Access.
20022
No Express entities were imported. Review the Patran supported Express
Geometric Entity list and the status of the entity filters under "Express Options".
Preview the Express Neutral file to review file content.
20023
No Patran entities were created from the Express Neutral file import.
20024
Patran Express Neutral File %A% has been saved.
20025
The Express File has no geometric entities recognized by Patran.
20026 Traversing CADDS 5 Part File %A% ...
20027 CADDS 5 Part File Traversal Completed.
20028 Traversing Unigraphics Part File %A% ...
1886 PCL Reference Manual
Introduction
1000000 ASM
1000001 Point %I% does not exist. Unable to continue.
1000002 Point %I% does not exist. Do you wish to continue?
1000003 Line %I% does not exist. Unable to continue.
1000004 Line %I% does not exist. Do you wish to continue?
1000005 Patch %I% does not exist. Unable to continue.
1000006 Patch %I% does not exist. Do you wish to continue?
1000007 Hpat %I% does not exist. Unable to continue.
1000008 Hpat %I% does not exist. Do you wish to continue?
1000009 Coordinate Frame %I% does not exist. Unable to continue.
1000010 Coordinate Frame %I% does not exist. Do you wish to continue?
1888 PCL Reference Manual
Introduction
1000011 Grid
1000012 Line
1000013 Patch
1000014 Hpat
1000015 Point %I% does not exist. Unable to continue.
1000016 Point %I% does not exist. Do you wish to continue?
1000017 Curve %I% does not exist. Unable to continue.
1000018 Curve %I% does not exist. Do you wish to continue?
1000019 Surface %I% does not exist. Unable to continue.
1000020 Surface %I% does not exist. Do you wish to continue?
1000021 Do you wish to delete the original lines?
1000022 %I% pages of memory open. Requested %I% more pages.
1000023 Error attempting to change virtual memory by %I% words. Status = %I%
1000024 %I% pages of virtual memory open.
1000025 Error attempting to allocate virtual memory.
1000026 Axis %I% does not exist.
1000027 Axis %I% does not exist. Do you wish to continue?
1000028 Do you wish to trim the original curve %I%?
1000029 Do you wish to delete the original points?
1000030 Do you wish to delete the original patches?
1000031 Do you wish to delete the original hpats?
1000032 Solid %I% does not exist. Unable to continue.
1000033 Solid %I% does not exist. Do you wish to continue?
1000034 %A% %I% already exists at the specified location to create the next %A%. Do you
wish to create a duplicate %A%?
1000035 %A% %I% already exists. Will you permit overwrite?
1000036 Do you wish to delete the original coords?
1000037 Line %I% has an arc length which is less than the geometric modeling tolerance.
Geometry may not be suitable for meshing operations.
1000038 Patch %I% has serious geometric errors. Geometry may not be suitable for meshing
operations.
1000039 Hpat %I% has serious geometric errors. Geometry may not be suitable for meshing
operations.
1000040 Duplicate %A% was not created at users request.
1000041 Adding %I% vertices to the database.
Chapter 11: Status Messages 1889
Introduction
1000070 Hpats
1000071 Solid Face %I% created in same location as %A%
1000072 Plane definition is blank. Input required data.
1000073 ID list is blank or an invalid character was used. Input required data.
1000074 Vector list is blank. Input required data.
1000075 Plane list is blank. Input required data.
1000100 %I% Point created: %V%
1000101 %I% Points created: %V%
1000102 %I% Line created: %V%
1000103 %I% Lines created: %V%
1000104 %I% Patch created: %V%
1000105 %I% Patches created: %V%
1000106 %I% Hpat created: %V%
1000107 %I% Hpats created: %V%
1000108 0 Points created.
1000109 0 Lines created.
1000110 0 Patches created.
1000111 0 Hpats created.
1000112 0 Coordinate Frames created.
1000113 %I% Point deleted: %V%
1000114 %I% Points deleted: %V%
1000115 %I% Line deleted: %V%
1000116 %I% Lines deleted: %V%
1000117 %I% Patch deleted: %V%
1000118 %I% Patches deleted: %V%
1000119 %I% Hpat deleted: %V%
1000120 %I% Hpats deleted: %V%
1000121 Unable to delete line %I%
1000122 %I% Coordinate Frames deleted: %V%
1000123 Unable to delete coord %I%
1000124 %I% Coordinate Frame deleted: %V%
1000130 %I% Coord created: %V%
1000131 %I% Coords created: %V%
1000132 %I% Point deleted: %A%
Chapter 11: Status Messages 1891
Introduction
1000178 %A% has been meshed. Do you wish to delete its associated elements and nodes? "
1000200 "%A%" is not a recognized syntax for a Point List.
1000201 "%A%" is not a recognized syntax for a Curve List.
1000202 "%A%" is not a recognized syntax for a Surface List.
1000203 "%A%" is not a recognized syntax for a Solid List.
1000204 "%A%" is not a recognized syntax for a Coordinate Frame.
1000205 "%A%" is not a recognized syntax for a DxDyDz Vector List.
1000206 "%A%" is not a recognized syntax for an Origin List.
1000207 Entity list is blank. Either select entities or exit menu by selecting another option.
1000208 "%A%" is not a recognized syntax for an Axis List.
1000209 Needed three scale factor values. Program using scale factors %F5.3%, %F5.3%,
%F5.3%.
1000210 Angle of rotation for a parametric entity is greater than 180 degrees.
1000211 The length of the Axis equals zero.
1000212 The radius of the arc equals zero.
1000213 The HPAT will have zero thickness.
1000214 "%A%" is not a recognized syntax for a matrix.
1000215 Wrong number of Arguments.
1000216 Unable to properly process the output labels.
1000217 The number of entities is greater than the number of labels to be assigned. Database
assigning %I% label.
1000218 The number of entities is less than the number of labels to be assigned. Ignoring %I%
extra label.
1000219 The number of entities is greater than the number of labels to be assigned. Database
assigning %I% labels.
1000220 The number of entities is less than the number of labels to be assigned. Ignoring %I%
extra labels.
1000221 The number of entities in for input lists 1 and 2 do not match. Ignoring extra entities
in list "%A%"
1000222 There must be at least one vector as input. The invalid value input was %A%
1000223 The maximum error detected during the manifold operation for %V% was %G%
1000224 Invalid glide option %A%. Must be 0,1,or 2.
1000225 Unable to do glide option.
1000226 The angle which the involute traverses must be positive.
1000227 The starting angle of the involute must be positive.
Chapter 11: Status Messages 1893
Introduction
1000502 The Radius of the Arc is %G%, the Total Angle is %G%, and the Center is at X =
%G%, Y = %G%, Z = %G%
1000503 It is not possible to order the curves from head to tail.
1000504 %I% Line merged into %I%
1000505 %I% Lines merged into %I%
1000506 The maximum error found while merging curves was %G%
1000507 Specified Parameterization Method value of %I% is invalid. Valid values are 1 and 2
1000508 Specified Parametric Position value of %G% is out of range. The value must be
between 0.0 and 1.0
1000509 Unable to create a line with the specified parametric position value of %G%
1000510 Unable to create a line with the specified parametric position values of %G% and
%G%
1000511 Specified Manifold Entity Type value of %I% is invalid. Valid values are 0, 1, 2, and
3
1000512 Unable to delete line %I%. Error status = %I%
1000513 %I% Line fit through %I% Points.
1000514 %I% Lines fit through %I% Points.
1000515 The maximum error found while fitting points was %G%
1000516 The points are all within tolerance of one another. A zero length line will not be
produced.
1000517 The Line Construct parameter "%A%" was reset from the invalid input value of %I%
to the default value of %I%
1000518 Specified Parametric Direction value of %I% is invalid. Valid values are 1 and 2
1000519 There must be at least one line as input. The invalid value input was %A%
1000520 There must be at least two lines input for a Spline Line. The invalid value input was
%I%
1000521 There must be at least three points input for a Spline Line. The invalid value input
was %A%
1000522 %I% Spline segments connecting %I% Points.
1000523 The number of points (%I%) is insufficient for the Number of Spline Segments
(%I%) to create. There must be at least one more point than the number of segments.
1000524 Duplicate points on Spline Line.
1000525 The points used to create the Spline Line are too close.
1000526 The number of Spline Segments requested to create (%I%) is less than the actual
number of Piecewise Cubic Spline Segments that may be created (%I%) to connect
the Spline breakpoints. Do you wish to create %I% instead of %I% Spline Segments?
Chapter 11: Status Messages 1895
Introduction
1000527 The number of lines per intersection must be greater than or equal to zero. The invalid
value input was %I%
1000528 %I% Lines created from the intersection of %I% surface(s) vs. %I% surface(s).
1000529 %I% Line created from the intersection of %I% surface(s) vs. %I% surface(s).
1000530 Fitting lines to the surface intersection points...
1000531 The maximum error found between the intersection points and the curves was %G%
1000532 A Virtual File Access error has occurred.
1000533 An error has occurred during the surface/surface intersection algorithm. Probable
cause is degenerate geometry.
1000534 The intersection points are all within tolerance of one another. A zero length line will
not be produced.
1000535 No intersections found between surface(s) %A% and surface(s) %A%.
1000536 There must be at least one curve as input. The invalid value input was %A%
1000537 The number of lines per projection must be greater than or equal to zero. The invalid
value input was %I%
1000538 An error has occurred during the curve/surface projection algorithm. Probable cause
is degenerate geometry.
1000539 The points created to approximate the projection line are all within tolerance ( %G%
). Try making the Max. Deviation Tolerance on the Project Tolerances form larger
and try again.
1000540 The projection vector has zero length.
1000541 No intersections found between projected curve(s) %A% onto surface(s) %A%.
1000543 No curves in the curve list define a plane to compute a normal projection vector from.
Specify a vector for projection.
1000544 %I% Lines created from the projection of %I% curve(s) onto %I% surface(s).
1000545 %I% Line created from the projection of %I% curve(s) onto %I% surface(s).
1000546 The maximum error found between the projection curves and the surfaces was %G%
1000547 No curves were found to exist in the database as defined in the curve list. The curve
list input was %A%
1000548 The curve is straight, therefore, a tangent cannot be calculated.
1000549 The curve and point are not coplanar, therefore, a tangent cannot be calculated.
1000550 There is not a tangent which connects the point with the curve.
1000551 The curve is straight and has no tangent.
1000552 The two curves are not coplanar so a tangent cannot be calculated.
1000553 Unable to find tangent from the first curve to the second curve from the given start
points.
1896 PCL Reference Manual
Introduction
1000554 An error occurred during the manifold operation for manifold curve %A%.
1000555 The two curves are collinear so an intersection point cannot be calculated.
1000556 The two curves are not coplanar so an intersection point cannot be calculated.
1000557 The fillet radius value is unacceptable. The radius value of %G% must be greater
than the fillet tolerance value of %G%.
1000558 The fillet line with radius %G% cannot be created between the two input curves.
1000559 The intersection point of the pair of curves to extend is within geometric tolerance (
%G% ) of both curves. The original curves were not extended.
1000560 Both curves used to create a fillet between are edges, and were not trimmed.
1000561 One of two curves used to create a fillet between is an edge, and was not trimmed.
1000562 The curve to trim is an edge, and was not trimmed.
1000563 The curve is not planar, therefore, a tangent cannot be calculated.
1000564 Data for curve %I% not found.
1000565 The curve to trim is an edge, and trimming edges is not allowed.
1000566 Error evaluating curve %I% for trimming. Unable to trim the original curve.
1000567 Error evaluating curves %I% and %I% for trimming. Unable to trim the original
curves.
1000568 Error evaluating curve for extending. Unable to extend the original curve.
1000569 The curve trying to extend has a tangent of length zero. Unable to extend curve.
1000570 The extended curve length of %G% is invalid. Input length value greater than zero.
1000571 The fillet curve has a zero angle of rotation. The fillet cannot be created.
1000572 The fillet curve has a zero radius. The fillet cannot be created.
1000573 Curve %I% does not have the required Company of Origin (PDA Engineering) to
construct a Line using the %A% Option. Unable to continue.
1000574 There must be at least two curves as input to Blend. The invalid value input was %A%
1000575 Line %I% with vertices %I% and %I% cannot blend with Line %I% with vertices
%I% and %I%.
1000576 One of the curves input to blend has a vector length of zero. Unable to blend curves.
1000577 No intersections found between curve(s) %A% and curve(s) %A%.
1000578 The number of Curves per Arc must be greater than or equal to one. The invalid value
input was %I%
1000579 The number of Curves per Circle must be greater than or equal to two. The invalid
value input was %I%
1000580 The two input curves do not intersect within tolerance of %G%. The minimum
distance is %G%. A point of closest approach on each input curve was provided.
1000581 The selected curve %I% has no center of curvature. A point was not created.
Chapter 11: Status Messages 1897
Introduction
1000723 Input surface list contains degenerate patch %I%. Skipped and continuing.
1000724 The edge between patches %I% and %I% does not match. Unable to blend patches.
1000725 The three patches %I%,%I% and %I% share a common edge. Unable to blend
patches.
1000726 Patch %I% does not share an edge with another input patch. It will not be blended.
1000727 Cannot blend with less than two patches.
1000728 Patch %I% was not input. Weight assignment skipped.
1000729 Weight Factor %G% is out-of-range. 0.0 <= WEIGHT FACTOR <= 1.0. Weight
Factor of %G% will be assigned.
1000730 Edge Number %I% is out-of-range. 1 <= EDGE NUMBER <= 4. Weight
assignment skipped.
1000731 Patch %I% Edge %I% has been assigned a second weight value. %G% was
overwritten with %G%.
1000732 There are no valid weight factor values in the input weighting factors list. Invalid
input is %A%. Input valid values 0.0 <= WEIGHT FACTOR <= 1.0.
1000733 In the process of finding an equivalent patch edge, patch vertices were found to be
out of range. 1 <= VERTEX NUMBER <= 4. Unable to blend patches.
1000734 In the process of finding an equivalent patch edge, patch vertices were found to be
equal. Unable to pblend patches.
1000735 The maximum error found while decomposing Patch %I% was %G%
1000736 Unable to decompose the Patch due to a manifold error.
1000737 Surface %I% used to create a fillet does not intersect with the fillet surface edges and
was not trimmed. Refer to the maximum error value and check for a large deviation
in the fillet creation.
1000738 Surfaces %I% and %I% used to create a fillet do not intersect with the fillet surface
edges and were not trimmed. Refer to the maximum error value and check for a large
deviation in the fillet creation.
1000739 Cannot create a five-sided patch. Only one patch created for this break.
1000740 No solids were found to exist in the database as defined in the solid list. The solid list
input was %A%
1000741 The maximum error of %G% occurred during approximation of general curve(s) into
Parametric Cubic(s).
1000742 The maximum error of %G% occurred during approximation of general surface(s)
into Parametric BiCubic(s).
1000743 The maximum error of %G% occurred during approximation of general solid(s) into
Parametric TriCubic(s).
1000744 Specified Least Squares Method value of %I% is invalid. Valid values are 1, 2, or 3.
1000900 Specified Manifold Entity Type value of %I% is invalid. Valid values are 0 and 3
Chapter 11: Status Messages 1899
Introduction
2000000 FEM
2000001 node
2000002 bar
2000003 tria
2000004 quad
2000005 tetra
2000006 pyra
2000007 wedge
2000008 hex
2000009 element
2000010 There are no %A6% elements in group %A%.
2000011 nodes
2000012 elements
2000013 curve
2000014 surface
2000015 solid
2000016 base of Solid %I%
2000017 top of Solid %I%
2000018 Node
2000019 Bar
2000020 Tria
2000021 Quad
2000022 Tetra
2000023 Pyra
2000024 Wedge
2000025 Hex
2000026 Element
2000027 Nodes
2000028 Elements
2000029 pair
2000030 pairs
Chapter 11: Status Messages 1901
Introduction
2001092 Solid %I% has an unacceptable mesh definition. Number of elements: %I% %I%
%I% %I% %I% %I% %I% %I% %I% %I% %I% %I%.
2001093 Mesh definition requires a transition mesh on degenerate %A%. Not permitted.
2001094 Triangle elements were produced on %I% surface(s). This can be avoided by making
the total number of elements around each surface perimeter an even number.
2001095 Wedge elements were produced on %I% solid(s). This can be avoided by making the
total number of elements around each transition face perimeter an even number.
2001096 %A% cannot be meshed with the specified mesh definition.
2001097 The mesh definitions for %A% and %A% are conflicting.
2001098 No mesh exists on curve %I%. Do you wish to continue?
2001099 No mesh exists on solid %I%. Do you wish to continue?
2001101 Unable to mesh degenerate SGM surface with specified mesh parameters. One finite
element edge or a mesh seed of one mesh edge will be created on the surface edge
segment. This may not be suitable for subsequent meshing. This degenerate edge
segment can be repaired using tools, such as Edit, Point, Equivalence from the
Geometry menu. After any repair, the mesh seed should be reapplied.
2001102 %A% has interior hard geometry. Isomesh may not match it. Do you wish to
continue?
2001103 Do you wish to delete the existing mesh on %A%?
2001104 No nodes or elements were created for %A%.
2001105 %A% %I% does not exist.
2001106 %A% entry is blank.
2001107 %A% has not been meshed. Do you wish to skip it and continue?
2001108 Aligning midnodes for %I% elements on %A%.
2001109 %A% is not biparametric so it cannot be meshed by IsoMesh. Either decompose
surface or use Paver.
2001110 %A% is not triparametric so it cannot be meshed by IsoMesh.
2001111 %A% is in element property region "%A%" which does not support %A%. Do you
wish to continue?
2001112 %A% is not biparametric so it cannot be meshed by IsoMesh. Do you wish to skip it
and continue?
2001113 %A% is not triparametric so it cannot be meshed by IsoMesh. Do you wish to skip
it and continue?
2001114 %A% cannot be meshed with %A% elements. Do you wish to mesh it with tet
elements? ("No" or "NoForAll" will skip this solid and continue.)
2001115 The IsoMesher cannot mesh solid %A% even with tet elements. Ignored.
2001116 %A% already has a beam mesh.
1904 PCL Reference Manual
Introduction
2001174 The Edge Length Fraction, %G%, may be inappropriately large and may collapse the
elemnts. Do you wish to continue.
2001175 Minimum l/L must be between 0.05 and 1.0
2001200 Element %I% does not exist. Do you wish to continue?
2001211 Invalid Element ID List: "%A%".
2001212 The Element ID List contains %I% duplicate ID(s).
2001213 %I% ID(s) in the Element ID List already in use: %A%
2001214 The number of elements generated is larger than the number of element IDs listed in
"Element ID list". The last ID used from the list is ID = %I%. Remaining elements
are numbered sequentially starting with ID = %I%.
2001215 Unable to associate an element with the proper order of geometry.
2001216 Negative IDs or IDs greater than 2,147,483,647 are not permitted in the element ID
list.
2001217 There are no elements associated with %A%.
2001218 Element list is blank.
2001219 Element edge list is blank.
2001220 No valid element IDs in list: "%A%"
2001221 No valid element edge IDs in list: "%A%"
2001222 Unable to create element with invalid ID ( < 0 or > 2,147,483,647 ).
2001223 One invalid element face was found in the input list. The invalid face will be ignored.
2001224 %I% invalid element faces were found in the input list. The invalid faces will be
ignored.
2001225 No valid element faces found in the input list.
2001300 Node %I% does not exist. Do you wish to continue?
2001301 No valid node IDs in list: "%A%"
2001302 Coordinates for node %I% do not exist.
2001311 Invalid Node ID List: "%A%".
2001312 The Node ID List contains %I% duplicate ID(s).
2001313 %I% ID(s) in the Node ID List already in use: %A%
2001314 The number of nodes generated is larger than the number of node IDs listed in "Node
ID list". The last ID used from the list is ID = %I%. Remaining nodes are numbered
sequentially starting with ID = %I%.
2001315 Node %I% still associated with an element and cannot be deleted.
2001316 Node %I% still associated with an element and cannot be deleted.
2001317 Node %I% still associated with an MPC and cannot be deleted.
2001318 Negative IDs or IDs greater than 2,147,483,647 are not permitted in the node ID list.
Chapter 11: Status Messages 1907
Introduction
2002021 Okay to split quad element %I% with a taper factor of %G%? ( Exceeds threshold of
%G% )
2002022 Quad element %I% has a taper factor of %G%. ( Exceeds threshold of %G% )
2002023 Tria Skew Test Results
2002024 Element Verification Threshold Factor is %F4.3%. Must be greater than 0. or less
than or equal to %F4.3%.
2002025 Tria element %I% has a skew factor of %G%. ( Exceeds threshold of %G% )
2002026 There are no shell elements in group %A%.
2002027 Unable to compute normal vector for element %A%. Skipped.
2002028 Guiding element ID not specified. Do you wish to continue and use the first element
encountered?
2002029 Guiding element %I% is not in group %A%.
2002030 Testing for reversed normals is indeterminate at a shell branch. Do you wish to
proceed under the assumption that elements meeting at a branch junction are not
connected to each other?
2002031 Reversed normals detected for %I% %A% in group %A%.
2002032 There are NO reversed normals in group %A%.
2002033 Normal direction corrected for %I% %A%.
2002034 Tria element %I% has a aspect factor of %G%. ( Exceeds threshold of %G% )
2002035 Tet element %I% has a aspect factor of %G%. ( Exceeds threshold of %G% )
2002036 Tet Collapse Test Results
2002037 Tet Aspect Test Results
2002038 Tet element %I% has a collapse factor of %G%. ( Exceeds threshold of %G% )
2002039 Calculating Collapse Factor for %I% elements.
2002040 Wedge Aspect Test Results
2002041 Wedge element %I% has a aspect factor of %G%. ( Exceeds threshold of %G% )
2002042 Wedge Face Skew Test Results
2002043 Wedge element %I% has a face skew factor of %G%. ( Exceeds threshold of %G% )
2002044 %A% element %I% has a %A% %A% of %F6.4%.
2002045 skew
2002046 aspect
2002047 warp
2002048 taper
2002049 face skew
2002050 collapse
Chapter 11: Status Messages 1909
Introduction
2006005 Invalid Geometry Flag in the MPC Type definition. This is not a nodal MPC.
2006006 Invalid MPC ID %I% specified. The ID must be positive.
2006007 MPC %I% already exists. Will you permit overwrite?
2006008 Unable to delete MPC %I%.
2006009 Invalid number of terms %I% specified. The number of terms must be positive.
2006010 No dependent terms have been specified.
2006011 No independent terms have been specified.
2006012 The number of dependent terms %I% is not in the valid range (%I% to %I%) for this
MPC type.
2006013 The number of dependent terms %I% is invalid. Exactly %I% dependent terms must
be specified for this MPC type.
2006014 The number of independent terms %I% is not in the valid range (%I% to %I%) for
this MPC type.
2006015 The number of independent terms %I% is invalid. Exactly %I% independent terms
must be specified for this MPC type.
2006016 No nodes specified for term %I%.
2006017 The number of nodes in each dependent term must be equal for this MPC type.
2006018 The number of nodes in each independent term must be equal for this MPC type.
2006019 The number of nodes per dependent term %I% is invalid. Exactly %I% nodes must
be specified in each dependent term for this MPC type.
2006020 The number of nodes per independent term %I% is invalid. Exactly %I% nodes must
be specified in each independent term for this MPC type.
2006021 The number of nodes per dependent term %I% is invalid. It must be a multiple of
%I% for this MPC type.
2006022 The number of nodes per independent term %I% is invalid. It must be a multiple of
%I% for this MPC type.
2006023 The ratio of the number of nodes per dependent term to the number of nodes per
independent term (%I% to %I%) is invalid. It must be %I% to %I% for this MPC
type.
2006024 The number of DOFs in each dependent term must be equal for this MPC type.
2006025 The number of DOFs in each independent term must be equal for this MPC type.
2006026 The number of DOFs in each term must be equal for this MPC type.
2006027 The number of DOFs %I% in term %I% is invalid. The number of DOFs in each
dependent term must be less than or equal to %I% for this MPC type.
2006028 The number of DOFs %I% in term %I% is invalid. The number of DOFs in each
independent term must be less than or equal to %I% for this MPC type.
Chapter 11: Status Messages 1915
Introduction
2006029 Degree of freedom %A% of Node %I% specified in more than one term which is not
valid for this MPC type.
2006030 Node %I% specified in more than one term which may not be valid for this MPC type.
Do you wish to continue?
2006031 Degree of freedom %A% specified in term %I% is not valid for this MPC type.
2006032 No terms have been specified.
2006033 Unable to acquire %I% characters of virtual memory.
2006034 MPC %I% does not exist.
2006035 Unable to read Sub-MPCs for MPC %I%.
2006036 Unable to read terms for Sub-MPC %I% of MPC %I%.
2006037 MPC %I% is not valid for the current Analysis Code and Analysis Type preferences
and therefore cannot be shown.
2006038 MPC %I% is not valid for the current Analysis Code and Analysis Type preferences
and therefore cannot be modified.
2006039 Invalid MPC ID specified. Negative MPC IDs or IDs greater than 2,147,483,647 are
not allowed.
2006040 Error writing MPC %I% to the database.
2006041 Error modifying MPC %I% in the database.
2006042 MPC %I% created.
2006043 MPC %I% modified.
2006044 MPC %I% deleted.
2006045 No MPC Definitions exist for analysis code "%A%" and analysis type "%A%".
2006046 No Coordinate Frame specified.
2006047 No Dependent Region list specified.
2006048 No Independent Region list specified.
2006049 No Nodes in the model.
2006050 The number of nodes associated to entities in the dependent region (%I%) and the
independent region (%I%) are not equal.
2006051 Cylindrical Coordinate Frame
2006052 Normal Coordinate Frame
2006053 Coordinate Frame %I% does not exist.
2006054 Coordinate Frame %I% is not a cylindrical coordinate frame.
2006055 No independent node found for dependent node %I% within the specified tolerance
(%G%).
2006056 More than one independent node found for dependent node %I% within the specified
tolerance (%G%).
1916 PCL Reference Manual
Introduction
2006059 Node pair %I% and %I% are coincident. This is only allowed if their radial
coordinates are zero.
2006060 The difference in the theta coordinates of node pair %I% and %I% does not divide
evenly into 360 degrees.
2006061 The difference in the theta coordinates of the all of the node pairs are not equal within
tolerance (%G%).
2006064 Invalid Coordinate Frame Option "%A%" specified. Valid options are "Automatic"
and "User Specified".
2006065 Invalid Normal Axis "%A%" specified. Valid axes are "Axis 1", "Axis 2" and "Axis
3".
2006066 Invalid Node Comparison Tolerance specified. The tolerance must be greater than
zero.
2006067 There are no nodes associated to the dependent region entities.
2006068 There are no nodes associated to the independent region entities.
2006069 Unable to transform the nodal coordinates from the global coordinate frame to
Coordinate Frame %I%.
2006070 The dependent region list "%A%" contains invalid entities. Do you want to ignore
them?
2006071 The independent region list "%A%" contains invalid entities. Do you want to ignore
them?
2006072 Unable to create a coordinate frame.
2006073 Unable to associate Coordinate Frame %I% to Node %I% as the Analysis Coordinate
Frame.
2006074 Rectangular Coordinate Frame %I% created for nodes which lie on the axis of
symmetry.
2006075 %I% rectangular coordinate frame(s) starting at ID %I% were created normal to the
surface(s).
2006076 Node %I% found in both the dependent and independent regions. This is only
allowed if the radial coordinate of the node is zero.
2006077 Node %I% found in both the dependent and independent regions.
2006078 Unable to read the MPC Type Definition for MPC %I% from the database.
2006079 Unable to read the MPC Type Definition for MPC Type %I% from the database.
2006080 Unable to read the valid degrees of freedom for MPC Type "%A%" from the
database.
2006081 The Analysis Coordinate Frame of %I% nodes has been overwritten.
2006082 Storing the MPC in the database.
2006083 Assigning Analysis Coordinate Frames to Nodes.
Chapter 11: Status Messages 1917
Introduction
2006084 Invalid Node Comparison Tolerance %G% specified. The tolerance must be greater
than zero.
2006085 MPC %I% in Neutral File has type of %A% which is not a valid 2.5 MPC type. MPC
is ignored.
2006086 There must be a total of six independent degrees of freedom for this MPC type.
2006087 Only two different nodes can be used for this MPC type.
2006088 The minimum and maximum sequence values must be associated with independent
terms.
2006089 Only three different nodes can be used for this MPC type.
2006090 Invalid DOF list specified. Only one DOF may be selected.
2006091 MPC %I% not imported because referenced node %I% does not exist.
2006092 RSPLINE G/C pairs may not be properly ordered. Check for proper sequencing in the
element/modify/MPC form.
2007001 No valid node locations in list: "%A%"
2007002 No valid node ids in list: "%A%"
2007003 No valid node ids in corner %I% node list
2007004 No valid Reference CID in list: "%A%"
2007005 No valid Analysis CID in list: "%A%"
2007006 No valid element IDs in list: "%A%"
2007007 Invalid FEM entity type code
2007008 Hybrid Surface Mesher supports Tria3, Tria6 and Tria9 element types only
2007020 Too many IDs in list: "%A%". Only %I% allowed.
2007021 Too few IDs in list: "%A%". Must be at least %I%.
2007022 Too few IDs in list: "%A%". Must be at least %I% to match the number of elements
specified.
2007023 Only %I% new node IDs in list. Must be at least %I% to match the number of nodes
specified.
2007024 Must be at least %I% nodes in corner node list %I%.
2007030 === ELEMENT %I% CREATED. CONNECTIVITY LIST: "%A%"
2007032 === Nodes %I% created.
2007040 Attempting to calculate parametric coordinates, but geometry was not specified.
2007041 Element %I% is of type "%A%", cannot convert to type "%A%".
2007042 Element topology %A% is not valid for for the property set currently assigned to
element %I%. The property set is %A%.
2007043 Unable to evaluate point %I%. OK to create unassociated node?
2007044 Unable to evaluate curve %I%. OK to create unassociated node?
1918 PCL Reference Manual
Introduction
2008006 Could not find a vertex within geometric tolerance of the node on %A%. Try a larger
geometric tolerance.
2008007 Unable to optimize mesh mesher nodes on %A%. May be due either to the size of the
model or to the existence of one or more unreferenced nodes.
2008008 The mesher could not complete the mesh on %A%. A surface has degeneracies where
the normal does not exist. The surface should probably be edited or changed to form
new geometry without this class of degeneracy.
2008009 The mesher cannot mesh %A% because it is poorly defined or the associated
topology is invalid.
2008010 Error while smoothing the mesh on %A%. Varying mesh size may allow completion
of the mesh.
2008011 Error while improving mesh topology by means of inserting and deleting elements
within the mesher on %A%. Varying mesh size may allow completion of the mesh.
2008012 Unable to calculate a point on a curve or edge of %A%.
2008013 Unable to evaluate points or derivatives on %A%.
2008014 Mesher received a boundary with less than three edges on %A%. Try a smaller
element size.
2008015 Surface normal (%A%) is zero at Point %I%. x=%F4.3% y=%F4.3% z=%F4.3%.
2008016 Surface normal (%A%) is zero on curve %A%. x=%F4.3% y=%F4.3% z=%F4.3%.
2008017 Surface normal (%A%) is zero at x=%F4.3% y=%F4.3% z=%F4.3%.
2008018 Move on curve failure on %A%. Mesher reached the end of %A% while trying to
move from x=%F4.3% y=%F4.3% z=%F4.3%. (parametric location %F4.3%) %F%
units to %A% direction.
2008019 Unable to get enough elements from mfe.
2008020 %A% Would you like to retry using TRI elements?"
2008021 At least one of the midedge nodes was not snapped to the trim boundary.
2008022 Unable to extract midedge nodes.
2008023 Fatal List Manager error in the mesher.
2008024 Fatal Topology Engine error in the mesher.
2008025 Fatal MFE error in the mesher.
2008026 Fatal Hash Utility error in the mesher.
2008027 Unknown fatal failure in the mesher.
2008028 Only tria elements accepted in tria element shell.
2008029 Meshing aborted by user
2008030 %A%, edge %A% is circular but the Paver could create only one node for it.
2008031 Paver failed to mesh the following surfaces: %A%.
1920 PCL Reference Manual
Introduction
2008032 Error while remeshing to improve element quality in %A%. Varying mesh size may
allow completion of mesh.
2008033 Unable to create node locations on edge %A%. Please remove the surfaces that share
the offending edge, or edit the surfaces and retry meshing.
2008034 Inconsistent mesh on boundary %A% delete existing boundary mesh and retry again
2008050 Do you wish to continue with these boundary quad faces.
2008051 Do you wish to continue with these boundary tri faces.
2008052 Could not extract anything from the input list.
2008053 Only one geometric or element type can be used. mixed.
2008054 Solid has no surfaces and is not meshable.
2008055 Do you wish to continue with the next item?
2008100 %A% not valid in renumber list. Must input at least %I% IDs.
2008101 Duplicate IDs not permitted in renumber list: %A%. Must be at least %I%.
2008102 %I% FEM entity renumbered. New ID is: %V%
2008103 %I% FEM entities renumbered. New IDs are: %V%
2008104 No FEM entities renumbered.
2008105 Invalid IDs in list: %A%. IDs must be positive integers.
2008106 Generating %I% IDs beginning at %I% produces an invalid ID. Try a smaller start
ID.
2008107 New ids conflict with existing ids.
2008108 Generating IDs by offset %I% produces an invalid ID from %I%.
2008109 The id offset string, %A%, is invalid.
2008500 Element interpolation order must be 2, 3 or 4.
2008501 Element essential node is missing.
2008502 Unknown element shape.
2008503 Error Interpolating Hpat on Element.
2008504 Invalid element topology for PATRAN 2.5 library.
2008505 Calculating the free faces for %I% elements.
2008506 Calculating the free edges for %I% elements.
2008507 %A% is not valid for %A% %A% analysis.
2008508 Duplicate ids are not permitted in %A%.
2008509 Element edge midnode location calculation failed for p-element midnode placement.
2008510 Function execution will be aborted.
2008511 Edge midnodes will be placed at the linear edge midnode locations.
2008512 Function execution will continue.
Chapter 11: Status Messages 1921
Introduction
2009206 Invalid Gap Tolerance %F% specified. The tolerance must be greater than zero.
2009207 Invalid maximal gap angle %F% specified. The angle must be greater than zero.
2009208 %I% free edges stitched.
2009209 Error found in loading free edges.
2009210 Error found in splitting tria-elements.
2009211 Error found in updating free edge list.
2009212 Error found in building a gap line.
2009213 Error found in computing a gap angle.
2009214 Error found in computing a gap size.
2009215 %I% new hard points and associations created.
2009216 %I% nodes deleted in equivalencing.
2009901 === %I% node modified. ID = %A%.
2009902 === %I% nodes modified. IDs = %A%.
2009903 === %I% element modified. ID = %A%.
2009904 === %I% elements modified. IDs = %A%.
2011001 Unable to delete the following nodes: %V%.
2011002 Unable to delete the following elems: %V%.
2011003 The Repeat Count field is blank.
2011004 The Repeat Count must be greater than 0.
2011101 The Translation Vector field is blank.
2011111 Translating %I% nodes %I% times.
2011112 Translating %I% node %I% times.
2011113 Translating %I% nodes %I% time.
2011201 Translating %I% elements %I% times.
2011202 Translating %I% element %I% times.
2011203 Translating %I% elements %I% time.
2011301 The Rotation Angle field is blank.
2011302 The Offset Angle field is blank.
2011303 The Axis field is blank.
2011311 Rotating %I% nodes %I% times.
2011312 Rotating %I% node %I% times.
2011313 Rotating %I% nodes %I% time.
2011401 Rotating %I% elements %I% times.
2011402 Rotating %I% element %I% times.
Chapter 11: Status Messages 1923
Introduction
2012056 Vector field "%A%" is not valid for sweeping. Reason: %A%.
2012057 Invalid scale string "%A%".
2012058 Invalid normalize vector value "%I%".
2012059 Invalid curve parametrization value "%I%".
2012060 Invalid glide frame orientation value "%I%".
2012061 %I% is not a valid (glide guide) curve id.
2012062 Invalid curve string "%A%".
2012063 Unable to evaluate field vector.
2012064 Different number of Elements in Input lists.
2012065 No Elements in first Input list.
2012066 No Elements in second Input list.
2012067 No initial Element from first Input list.
2012068 No initial Element from second Input list.
2012069 Only 2d Element allowed.
2012070 Initial Element not found in first Input list.
2012071 Initial Element not found in second Input list.
2012072 Sweeper could not complete Input lists. This could be due to a crack, unequivalenced
Model or two different meshes.
2012073 Sweeper could not create a 3D Element between Element %I% and %I%.
2013001 Fem to geometry association processing aborted by user.
2013002 Meshes along edges %A% may not match. Subsequent meshes will use the definition
from the first mesh unless all associated meshes are deleted.
2013003 Unable to associate all elements to geometry. Please verify associations.
2013004 Failed to associate any node to point %A%
2013005 Failed to associate any node to curve %A%
2013006 Failed to associate any node to surface %A%
2013007 Unable to associate all nodes that lie within the box of the surface. Please check if all
nodes are associated to surface.
2013101 Nodes have been disassociated from geometry %A%.
2013102 Elements have been disassociated from geometry %A%.
2013103 Elements and nodes disassociated from geometry %A%.
2014001 Unable to make the following elements curvature continuous. Check element
associativity.
2090001 === No nodes created.
2090002 === %I% node created. ID = %V%.
1926 PCL Reference Manual
Introduction
3001005 Load Case Description "%A%" is too long. Input 256 characters or less.
3001006 Load Case "%A%" created.
3001101 Load Case "%A%" does not exist.
3001102 There is no Load Case selected. Select a Load Case.
3001103 "%A%" is the Current Load Case. Deletion of the Current Load Case is not permitted.
Make another load case the "Current" Load Case if you wish to delete this one.
3001104 Load Case "%A%" deleted.
3001105 Deletion of %I% Load/BC Sets assigned to load cases other than Load Case "%A%"
was prohibited.
3001106 The selected loadcase is associated with Nastran analysis subcase <%A%>. Loadcase
is not deleted.
3001107 The selected loadcase is associated with Abaqus analysis step <%A%>. Loadcase is
not deleted.
3001108 The selected loadcase is associated with Ansys analysis step <%A%>. Loadcase is
not deleted.
3001109 The selected loadcase is associated with Marc analysis step <%A%>. Loadcase is not
deleted.
3001110
The selected loadcase is associated with Patran Advanced Fea analysis step <%A%>.
Loadcase is not deleted.
3001111 The selected loadcase is associated with <%A%> analysis step <%A%>. Loadcase is
not deleted.
3001201 Load Case "%A%" already exists. Modify not permitted.
3001202 Load Case "%A%" modified.
3001203 The Load Case Name to be modified is "blank". Select an existing Load Case Name.
3001301 Load Case "%A%" has no Load/BC sets.
3001302 Two "%A%" Loads/BCs have the same priority of "%I%". Change one so that they
are unique.
3001303 "%I%" is an Invalid Priority. It must be greater than 0.
3001304 Database error encountered: %I%.
3001305 Dynamic memory allocation error encountered.
3001306 One or more of the selected LoadsBCs sets were already in the spreadsheet. Their
scale factors and priorities may have been modified.
3001307 Attempt to assign non-unique priority to Loads/BCs "%A%". Spreadsheet modify
aborted. Use "Undo" to undo partial changes.
Chapter 11: Status Messages 1929
Introduction
4000000 Results
4000001 Not ready yet
4000002 Graphics not ready yet
4000003 XY graphics not ready yet
4000004 No coordinate system defined
4000005
%I% curves are saved in the data base - Please use Patran XY plot module to
manipulate them
4000006 Feature is not fully functional
4000007 Too many XY curves. %I% curves are discarded
4000008 Insufficient memory
4000009 No result
4000010 Cannot access data
4000011 No nodes
4000012 No elements
4000013 No output locations for element results
4000014 No element results
4000015 No nodal results
4000016 Insufficient memory - Need %I% words, available %I% K words - File %A% at line
%I%
4000017 Invalid nodes
4000018 Invalid elements
4000019 Virtual allocation failure
4000020 Virtual deallocation error
4000021 Cannot get current group
4000022 Elements completely filtered out
4000023 Nodes completely filtered out
4000024 Assume static result cases with no animation parameters
4000025 Cannot get node coordinates
4000026 %A%: %A%
4000027 No tensor components
4000028 %I% element(s) not passing range filters
1930 PCL Reference Manual
Introduction
4001162 Only the first of the highlighted lists is copied to the data box. If you want to combine
lists, use "Build"
4001163 Cannot add list to the list box: Identical list exists.
4001164 Only the first of the highlighted lists is replaced by the list in the data box.
4001165 Intersection of the highlighted lists result in a null list
4001166 Nodes added to the group as required by the current plot.
4001167 Result "%A%" in result case "%A%" cannot be combined since result attributes are
not compatible.
4001168 The currently selected tensor component is not valid for 2D-tensors
4001169 Cannot derive max results with respect to result cases since result attributes are not
compatible
4001170 Cannot derive min results with respect to result cases since result attributes are not
compatible
4001171 Cannot derive averaged results with respect to result cases since result attributes are
not compatible
4001172 Cannot derive max results with respect to layers since result attributes are not
compatible
4001173 Cannot derive min results with respect to layers since result attributes are not
compatible
4001174 Cannot derive averaged results with respect to layers since result attributes are not
compatible
4001175 %I% vector(s) not passing filters
4001200 The normal at node %I% is an approximation and is not exact.
4001201 The results curve cannot be built.
4001202 Node %I% is not associated with a surface.
4001203 Cannot find a unique surface at node %I% to create the curve.
4001204 %A% is not a results curve.
4001300 This function prints min and max result at element nodes into the result capture file
or the text window
4001301 Find out
4001302 (1) If elements are associated with materials ( use res_modify_print_elems built-in
function )
4001303 (2) How many materials that had been defined for the model ( filtering results with
respect to materials and see how many items show up in the material list box ).
4001304 If (1) and (2) are OK, define an allowable for each material. For example, if you have
3 materials, type in the command window
4001305 REAL RESULT_MATL_ALLOWABLES(3) = 60000, 150000, 45000
Chapter 11: Status Messages 1939
Introduction
4001306 Difference cannot be computed without comparing it with the results in the
surrounding elements. Use All for Averaging Domain.
4001307 There is no layer position associated with the current result, hence no results can be
retrieved from the data base.
4001308 An unacceptable error has occurred ( for element %I%, shape = %I%, number of
nodes = %I%, number of output points = %I% ) in the extrapolation algorithm.
4001310 Cannot transform results to material system of 3D elements
4001311 There are duplicate element results in result case "%A%", result type "%A%"
4001312 There are duplicate nodal results in result case "%A%", result type "%A%"
4001313 Results can only be reported in the analysis system.
4002000 There are no parameters for a fringe plot
4002001 There are no parameters for a deformed plot
4002002 There are no parameters for a vector plot
4002003 There are no parameters for a tensor plot
4002004 Invalid option
4002005 There are no nodes or elements for plot
4002006 There are no results for plot
4002007 Attempt to extrapolate results twice
4002008 Unknown location for results extrapolation
4002009 There is no result being processed for plot
4002010 Results at node don't need to be averaged
4002011 Results need to be extrapolated to nodes for plot
4002012 Results need to be at element nodes for plot
4002013 Max difference of element results at nodes can be computed for "All" option only
4002014 Results can be averaged only for a predefined domain ( e.g. all elements, elements of
same materials, elements of same type )
4002015 Max difference of element results at nodes can be computed for "All" domain option
4002016 Invalid average method
4002017 Results are not extrapolated to nodes
4002018 Cannot load element results from data base into memory
4002019 Cannot load nodal results from data base into memory
4002020 Result cannot be interpolated to element centroid
4002021 Element results cannot be converted to nodal results
4002022 Results cannot be extrapolated to element nodes
4002023 Nodal result cannot be interpolated to element centroid
1940 PCL Reference Manual
Introduction
4005003 The %A% plot "%A%" already exists. You may view the list of existing %A% plots
in the Existing %A% Plots listbox displayed by the "Plot Options" icon. Do you want
to modify the "%A%" plot?
4005004 You need to specify the existing %A% plot that you want to modify.
4005005 The %A% Report attributes cannot be loaded because they are not consistent. This
was probably caused by an error in the GUI when the Report was created: the GUI
may have assigned report rows that should not exist for the selected data type (scalar,
vector, or tensor), Target Entity type (e.g., element or node), and Additional Display
Control entity attribute (e.g., free faces or element centroids).
4005006 %A% plot "%A%" has an inconsistent definition and cannot be displayed.
4005007 The Result Case Name should include a Load Case name and a Subcase name
separated by a comma.
4005008 There is not enough graphics memory for even a single frame, so no animation is
currently possible.
4005009 There is only enough graphics memory for 1 frame, so no animation is currently
possible.
4010000 There is no PCL expression defined.
4010001 "%A%" is an invalid PCL expression.
4010100 The Load Case Name is "blank". Input a Load Case Name.
4010101 The Subcase Name is "blank". Input a Subcase Name.
4010102 The Result Name is "blank". Input a Result Name.
4010103 A database error while trying to retrieve the numerical form of the result.
4010104 Select multiple result cases and/or multiple result positions.
4011000 "%A%" is not supported.
4011001 %I% is an invalid number of components.
4011002 Report will only be generated for the first result type.
4012001 Direct Results Access file time stamp has changed. To re-attach, please detach the
file using the Analysis form option Delete "Attachment" then re-attach. File: "%A%"
4012002
4012003
4012004 Direct Results Access file connection has been removed or does not exist.
4012005 Direct Results Access file is already attached. To re-attach with different Translation
Parameters, please detach the file using the Analysis form option Delete
"Attachment" then re-attach. File: "%A%"
4012006 No Direct Results Access file was specified. Please, select a file through the Select
Results File form before "Apply".
1944 PCL Reference Manual
Introduction
4012010 A result case is associated with the external Results file. Detach from Direct Results
Access file: "%A%". This operation cannot be undone. Do you want to continue?
4012011 Unable to detach Direct Results Access file: "%A%"
4012012 Detach from Direct Results Access file: "%A%". This operation cannot be undone.
Do you want to continue?
4012020 Unable to connect to Direct Results Access file.
4012021 Out of available memory when attaching file: "%A%"
4012022 Unable to open Direct Results Access file: "%A%". Please i) verify that the file
exists or ii) delete the attachment using the Analysis form option Delete
"Attachment" then re-attach.
4012023 Direct Results Access file connection limit exceeded (20 files max.). Please detach
from the un-used results file using the Analysis form option Delete "Attachment" in
order to make room for new DRA connections.
4012025 Direct Results Access file not found: "%A%"
4012027 Multiple subcases for Solutions 103, 105 and 107 are not supported in MSC.Access
for Pre-V70 MSC.Nastran.
4012028 The Direct Results Access file specified is invalid. Possible reasons: (i) the file is not
in XDB format, or (ii) the XDB file was generated on another Machine type. For case
(ii), please use the TRANS and RECEIVE utilities delivered by MSC Nastran to
convert the XDB file to the correct binary format for your machine type. File:
"%A%"
4012029 Unable to retrieve (Direct Results Access) data.
4012030 An internal error occurred when retrieving Direct Results Access data in routine:
"%A%".
4012031 Unable to create the Coordinate Frame with ID %I%: Already exists in database.
4012032 Unable to create node %I%: Already exists in database.
4012033 Unable to create element %I%: Already exists database.
4012034 Creating Group "%A%".
4012035 Unable to create group "%A%".
4012036 Too many duplicate nodes found in model. Subsequent warning omitted for this
model import.
4012037 Too many duplicate elements found in model - aborting. Possible reasons: (i) Model
Data request has already been imported or (ii) a Part Superelements with non-unique
Element IDs or Image Superelements exists which is currently not supported.
4012051 *** Begin: Attach MSC/ACCESS Result File ***
4012052 *** End: Attach MSC.Access Result File ***
4012055 Total execution time in real seconds: %F12.3%
4012056 Total execution time in CPU seconds: %F12.3%
Chapter 11: Status Messages 1945
Introduction
4012100
XDB file created by "Patran%A% V%A%" on %I%/%I%/%I% using "%A%"
4012101 Attaching Direct Results Access file: "%A%"
4012102 Processing result load case: %A%
4012103 Processing result sub-case: %A%
4500001 One of the input array arguments is of an insufficient dimension.
4500002 An error has occurred calculating a nodal averaged result.
4500003 A memory allocation error has occurred. Please check function inputs and call
RES_UTL_FREE_RESULTS() before proceeding.
4500004 No Nodes are found for the specified result matching the input list.
4500005 No Elements are found for the specified result matching the input list.
4500006 The Loadcase/Subcase/Primary Result/ Secondary Result Id combination specified
cannot be found.
4500007 The specified Layer Id is not associated with the specified result.
4500008 The input Location string is invalid.
4500009 No results are found in the database matching the specified Ids.
4500010 The derivation specified in invalid.
4500011 A error has occurred extrapolating this result to the element nodes.
4500012 The specified global variable is not found.
4500013 The filter method specified is not valid
4500014 An error has occurred interpreting the input List string.
4500015 The specified Coordinate Frame does not exist.
4500016 The input list type is not valid.
4500017 The specified operation is not valid.
4500018 The Coordinate Frame List is not valid.
4500019 The results specified for this operation are defined in an Unknown element local
coordinate system. The global system will be assumed for all transformation
operations. Errors may be introduced when using nodal averaged or transformed
result components.
4500020 The input path specified points which did not interpolate to any elements.
4500021 The specified dump file cannot be opened.
4600001 An error has occurred while manipulating data for the specified register.
4600002 The specified derivation is not valid for the datatype of the data register
4600100 An error has occurred while retrieving the specified results for the data register.
4600101 There is insufficient memory available to retrieve the specified result.
4600102 There are no results available matching the current register specification.
1946 PCL Reference Manual
Introduction
4700008 Element data is not valid for a node target. Please modify either target or averaging
domain.
4700101 The specified Results Display tool Fill type attribute is not valid.
4700102 The specified Results Display tool model style attribute is not valid.
4700103 The specified Results Display tool edge color attribute is not valid.
4700104 The specified Results Display tool edge line style attribute is not valid.
4700105 The specified Results Display tool edge style attribute is not valid.
4700106 The specified Results Display tool scale definition attribute is not valid.
4700107 The specified Results Display vector tool line style attribute is not valid.
4700108 The specified Results Display tool component color attributes are not valid.
4700109 The specified Results Display tool component flag attributes are not valid.
4700110 The specified Results Display tensor tool box display flag attribute is not valid.
4700111 The specified Results Display tensor tool box style attribute is not valid.
4700112 The specified Results Display deformation tool undeformed model flag attribute is
not valid.
4700113 The specified Results Display deformation tool undeformed model color attribute is
not valid.
4700114 The specified Results Display deformation tool deformed model style attribute is not
valid.
4700115 The specified Results Display fringe tool style attribute is not valid.
4700116 The specified Results Display tool On/Off flag attribute is not valid.
4700117 The specified Results Display tool color attribute is not valid.
4700118 The specified Results Display vector tool display attribute is not valid.
4700119 The specified Results Display vector tool attachment attribute is not valid.
4700120 The specified Results Display vector tool head style attribute is not valid.
4700121 The specified Results Display tensor tool display attribute is not valid.
4700122 The specified Results Display report tool type is not valid.
4700123 The specified Results Display report tool column keyword attribute is not valid.
4700126 The specified Results Display graph tool fit method attribute is not valid.
4700127 The specified Results Display graph tool curve style attribute is not valid.
4700128 The specified Results Display graph tool axis attribute is not valid.
4700129 The specified Results Display graph tool axis scale attribute is not valid.
4700130 The specified Results Display graph tool axis scale method attribute is not valid.
4700131 The specified Results Display graph tool axis format attribute is not valid.
4700132 The specified Results Display graph tool format method attribute is not valid.
Chapter 11: Status Messages 1949
Introduction
4700133 The specified Results Display graph tool axis significant digit attribute is not valid.
4700134 The specified Results Display tool filter type is not valid.
4700135 The specified Results Display deformation tool undeformed line style attribute is not
valid.
4700136 The specified Results Display deformation tool deformed line style attribute is not
valid.
4700137 The specified Results Display deformation tool deformed scale type attribute is not
valid.
4700138 The specified Results Display tool animation method is not valid.
4700139 The specified Results Display tool animation sequence is not valid.
4700140 The specified Results Display tool animation interpolation method is not valid.
4700141 A report cannot be generated using nodal data to create a non-nodal result.
4700142 A report cannot be generated using pure element data to create a nodal result.
4700143 The specified sort column contains character data, sorting will revert to default
(entity id).
4700144 Range filtering of results has been specified on a non-floating point sort column. A
sort column with floating point data must be selected when using filter ranges.
4700145 A Report data column format specifies a width exceeding the page width.
4700146 A scale factor of 0.0 has been specified for the posted tool. This will result in the
display/output of constant results all equaling zero.
4700201 The specified Results Display tool does not exist.
4700202 The specified Results Display tool for creation already exists.
4700203 The specified Results Display tool is not posted.
4700301 The specified Results Display tool register location is not valid.
4700401 The specified Results Display tool Data Register does not exist.
4700601 An error has occurred performing the specified PCL results calculation.
4700701 The specified target nodes or elements already have associated results data or the
specified target is empty or invalid.
6011004 The number of elements was found to be less than or equal to zero.
6011005 The number of properties was found to be less than or equal to zero.
6011006 An error has occurred while allocating in-core virtual memory.
6011007 The number of fields was found to be less than or equal to zero.
6011008 An error occurred while evaluating the fields.
6011009 The number of elements in the region is less than or equal to zero.
6011010 The number of elements in the region was found to be greater than specified.
6011011 The number of regions was found to be less than or equal to zero.
6011012 The number of elements in the region was found to be less than specified.
6011013 The number of nodes was found to be less than or equal to zero.
6011014 The number of Load/BC variables was found to be less than or equal to zero.
6011015 The number of Load/BC rows was found to be less than or equal to zero.
6011016 The distribution of rows was found to be uneven between the Load/BC variables.
6011017 The number of components for the Load/BC variable values was found to be less than
or equal to zero.
6011018 Error encountered while initializing the summary data.
6011019 Unable to determine integer value during conversion of character to integer from the
compressed flat file.
6011020 An error occurred while converting integer to character while compressing the flat file.
6011021 No coordinate frames were found in the database.
6011022 No element properties have been assigned to the element with id = %I%.
6011023 The element properties have not been defined for all of the elements in the model.
6011024 The database file named "%A%" does not exist.
6011025 The job name "%A%" could not be found in the specified database.
6011026 The job name is blank. Please enter a name.
6011027 The selected analysis code in the database is not %A%.
6011028 *** ERROR: The field references on <Entity %I%> in some loadsets are different.
Therefore, lbcs cannot be added. Check the lbc.
6011029 *** WARNING: The analysis coordinate frame reference on <Node %I%> is different
than the lbc coordinate frame reference. Therefore, this resulted in more displacement
constraints than specified. Check the lbc.
6011030 *** ERROR: The displacements constraints on the common <Node %I%> from lbc
sets are not the same. Check the lbc.
6011031 *** WARNING: The priority resolution for time/frequency loads is not supported at
this time. Check the loads.
Chapter 11: Status Messages 1951
Introduction
6011032 *** WARNING: The coordinate frame references on node_id <%I%> are not same.
The displacements are not added.
6011033 *** ERROR: The analysis coordinate frame reference on <Node %I%> is different than
the lbc coordinate frame reference. Therefore, the displacement constraints did not
transform.
6011034 The element with ID %I% already exists in the database.
6011035 There is not enough memory to %A%.
6011036 The element with ID %I% references a node that does not exist.
6011037 The node with ID %I% already exists in the database.
6011038 Some of the elements in property set "%A%" do not have values for "%A%".
6011039 Error processing a vector with an alternate coordinate frame.
6011040 The alternate coordinate frame specified with the vector has been skipped for property
%A%.
6011041 The slideline regions selected have duplicate nodes. This can happen if the curves
selected for Master and Slave regions are congruent. One way to solve this problem is
to have the two curves separated by a very small gap or make one curve longer than the
other. This can also happen if the Master and Slave curves are the same.
6012001 Unable to determine if file (%A%) is text or binary.
6012002 The file: (%A%) does not exist.
6012003 The value read from file: (%A%) was not in the range between LOWVAL and
HIGHVAL
6012004 Unable to open file %A%
6012005 Unable to close file %A%
6012006 Unable to read file %A%
6013001 An ERROR of unknown type occurred while reading the JOBFILE in routine %A%.
6013003 Unexpected END OF FILE reached in JOBFILE. The JOBFILE name is %A%.
6013006 READ ERROR occurred in READ_JOB_PARAMETER.
6013007 Array PARAM_TYPES has an entry that is invalid for READ_JOB_PARAMETER.
The JOBFILE line is %A%.
6013008 The parameter name read from the JOBFILE is a duplication of 1 or more entries in
PARAM_NAMES array in READ_JOB_PARAMETER. The JOBFILE line is %A%.
6013009 The parameter name read from the JOBFILE is not a valid abbreviation of any entry in
PARAM_NAMES array in READ_JOB_PARAMETER. The JOBFILE line is %A%.
6013010 READ_JOB_PARAMETER could not parse the value as specified in
PARAM_TYPES. The JOBFILE line is %A%.
6013011 The array PARAM_NAMES in READ_JOB_PARAMETER has blank entries, or
identical entries were detected. The JOBFILE line is %A%.
1952 PCL Reference Manual
Introduction
6013012 An error occurred in the definition of the PCL PATH while reading the jobfile.
6013013 An error occurred while allocating memory for an array in the jobfile.
6013014 The values could not be extracted from a list contained in the jobfile.
6013015 The database file name could not be found in in the jobfile named "%A%".
6013016 The job name could not be found in the jobfile named "%A%".
6013018 The data associated with the job parameter named "%A%" has been entered as an array.
The type indicated for retrieving this data is incorrect.
6013019 The data associated with the job parameter named "%A%" has been entered as a string.
The type indicated for retrieving this data is incorrect.
6013020 The data associated with the job parameter named "%A%" has been entered as a real.
The type indicated for retrieving this data is incorrect.
6013021 The data associated with the job parameter named "%A%" has been entered as an
integer. The type indicated for retrieving this data is incorrect.
6013022 A position could not be found in the job parameter directory for "%A%".
6013023 There are no more steps in the database for the requested job name.
6013024 The maximum number of characters that can be written to the control file for a
parameter is 240.
6013025 The control file "%A%" could not be created.
6013026 The job "%A%" could not be entered in the database.
6013027 The job has been aborted, because the integer value for the job parameter "%A%" could
not be entered in the database.
6013028 The job has been aborted, because the real value for the job parameter "%A%" could
not be entered in the database.
6013029 The job has been aborted, because the character value for the job parameter "%A%"
could not be entered in the database.
6013030 The job has been aborted, because the array for the job parameter "%A%" could not be
entered in the database.
6013031 The job has been aborted, because the stream entered for the job parameter "%A%"
could not be entered in the database.
6013032 The job has been aborted, because the job description "%A%" could not be entered in
the database.
6013033 The job has been aborted, because the path could not be entered in the database.
6013034 The jobfile named "%A%" does not exist.
6013035 The job "%A%" already exists. Do you wish to delete the existing job and create a new
one?
6013036 The job has been aborted, because the load case "%A%" does not exist.
6013037 The Job Name cannot exceed %I% characters.
Chapter 11: Status Messages 1953
Introduction
6013038 The maximum number of File Search Path is 100. You have exceeded the limit.
6016001 The selected operation (%A%) is not available for analysis code %A%. Do you wish
to continue with this analysis code selection?
6016002 The jobname (%A%) is already defined in the database. A new name must be specified
to continue. Do you wish to continue?
6016003 The jobname (%A%) is not defined in the database but does exist. Do you wish to
overwrite?
6016004 Jobname (%A%) was not overwritten, but a new name must be specified to continue.
Do you wish to continue?
6016005 The Selected Analysis File databox was not filled in. This databox must be filled in to
continue. Do you wish to continue?
6016006 A database error occurred while attempting to retrieve the Load Case names. Do you
wish to continue?
6016007 A database error occurred while retrieving the Load Case name list. Do you wish to
continue?
6016008 No "Action's" are available for the requested analysis code (%A%). The analysis code
has been restored to the previously active analysis code. Check the set_options.pcl for
the requested code.
6016009 Jobname (%A%) already exists in this database/directory. It will be changed to jobname
(%A%) to assure unique jobnames.
6016010 File name (%A%) exists and is about to be overwritten. If you want to save the existing
file, you will have to rename it immediately.
6016011 Spreadsheet will be reduced to %I% rows. Extra rows will be removed from the bottom.
Do you wish to continue?
6016012 The Number of Frequency Ranges must be greater than zero.
6016013 The Number of Data Rows must be greater than zero.
6016014 No Cells selected. Please select at least 1 for input.
6016015 Table Input Data box contains invalid data. Please fill in with Real data.
6016016 Table Input Data box contains invalid data. Please fill in with Integer data.
6016017 There are %I% Data Rows for the X-Direction but the Response Spectrum Name is
blank. A name must be entered to continue. Do you wish to continue?
6016018 There are %I% Data Rows for the Y-Direction but the Response Spectrum Name is
blank. A name must be entered to continue. Do you wish to continue?
6016019 There are %I% Data Rows for the Z-Direction but the Response Spectrum Name is
blank. A name must be entered to continue. Do you wish to continue?
6016020 Horizontal cell selection is not allowed since columns may be of different datatypes.
6016021 ERROR! Some character string exceeded the 240 character limit.
6016022 The number of selected loadcases is out of the range %I% to %I%.
1954 PCL Reference Manual
Introduction
6016023 The coordinate frame <%I%> does not exist in the database. Select a valid coordinate
frame
6016024 The node <%I%> does not exist in the database. Select a valid node.
6016025 The Results translation can be time consuming for large models. Do you wish to wait
for translation? The database will be closed during the translation. If you choose to
wait, the database will automatically be reopened.
6016026 Input Data box contains invalid or blank data. Please enter valid name.
6016027 The jobname (%A%) is already defined in the database. Do you wish to overwrite?
6016028 The stepname (%A%) is already defined in the database. Do you wish to overwrite?
6016029 The parameter (%A%) is already defined in the database. Do you wish to overwrite?
6016030 One of the parameters to be saved has an unknown parameter type.
6016031 None of the requested parameters were found in the parameter set.
6016034 The Job Name is blank.
6016035 The Job Name "%A%" is invalid.
6016036 The job has been aborted.
6016037 The oldjob name must be entered for a restart. Please enter the oldjob name in order to
continue.
6016038 Do you wish to submit job "%A%" for analysis now?
6016039 Do you wish to submit job "%A%" for analysis now?
6016040 Errors (%I%) encountered writing parameters to database? Regardless, do you wish to
submit job "%A%" for analysis now?
6016041 Analysis job step "%A%" not found and not deleted.
6016042 Analysis job step "%A%" not deleted. Step is associated with an existing job.
6016043 Full_Run or Check_Run Analysis for Abaqus Version 4.9 is not supported. Please
submit the analysis manually.
6016044 The base motion field name must be picked. Please pick a field in order to continue.
6016045 The %A% script could not be found in either the system or the PCL search paths.
6016046 The executable for %A% could not be found in either the system or the PCL search
paths.
6016047 Translator messages may be found in file: %A%
6016048 The database is not open.
6016049 Executing %A%
6016050 No command line arguments have been entered.
6016051 The translation has completed successfully.
6016052 The translation has completed with an error.
6016053 The analysis process id %I% could not be saved in the database.
Chapter 11: Status Messages 1955
Introduction
6016084 You are about to clear all the data on the spreadsheet. There will be no way to recover
this data. Are you sure you want to do that?
6016085 Data in this column must be entered with the lowest value at the top, and the highest
value at the bottom. (i.e. In accending order.)
6016086 A discontinuity was detected at either the first or last entry in the Modal Damping Data.
This is not allowed, and will cause a fatal error in the analysis.
6017001 The database file name is missing from the command line. Use the "-d" option to enter
the database file name.
6017002 The control file name (ie. the ".jba" file) or the database name and the jobname must be
entered on the command-line.
6017003 The jobname is missing from the command line. Use the "-j" option to enter the
jobname.
6017004 The control file name (ie. the ".jba" file) or the database name and the jobname must be
entered on the command-line.
6018001 No properties have been defined for the element with ID %I%.
6018002 Some elements in the model have no types or properties defined. Do you wish to
continue with the translation?
6018003 No elements have been defined for this model. Do you wish to continue with the
translation?
6018004 The group "%A%" is associated with %I% output requests in %A% "%A%" for the
%A% analysis preference.
6018005 The group "%A%" cannot be deleted, because it is associated with some analysis
parameters.
6018006 No properties have been defined for element property set "%A%".
6018007 This job has been aborted, because some of the element property sets in the model have
no properties defined.
6018008 Some of the element property sets in the model have no properties defined. Do you wish
to continue with the translation?
6018009 Some or all of the 2D Solid elements have negative normals. Correct the element
normals before submitting the analysis.
6018010 Generalized plane strain elements (CGPE) are present with other element types.
6020001 Creation date of the OUTPUT2 file is %A% %I%, 19%I%. The file label is %A%.
6020002
Messages output from the Patran %A% OUTPUT2 file translator (%A% %A% ) on
%A% at %A%.
6020003 Unable to open a new message file "%A%". Translation messages will be written to
"standard output".
6020004 Unable to open the specified OUTPUT2 file "%A%".
Chapter 11: Status Messages 1957
Introduction
6020005 The specified OUTPUT2 file "%A%" is not in standard binary format and cannot be
translated.
6020006 The specified OUTPUT2 file "%A%" has been successfully opened.
6020007 End of MSC Nastran OUTPUT2 file translation.
6020008 The following table or matrix block has been encountered "%A%".
6020009 Creating the new subcase "%A%". The MSC Nastran approach code for this subcase is
%I%.
6020010 Searching for or creating load case "%A%".
6020011 Translating %I% %A% node results.
6020012 Translating %I% %A% element results.
6020013 Creating the %A% %A% %A% result "%A%, %A%".
6020014 Group "%A%" does not exist in the database. Model data will not be translated.
6020015 Translating %I% nodes to the database.
6020017 Translating %I% elements to the database.
6020018 Needed file specification missing! The full name of the jobfile must be specified as the
first command-line argument to this program.
6020019 Unable to open the specified database, %A%. Writing the OUTPUT2 information to the
PCL command file, %A%.
6020020 Writing the OUTPUT2 information to the database, %A%.
6020021 Unable to open either the specified database, %A%, or a PCL command file, %A%.
6020022 Translating %I% coordinate frames to the database.
6020023 Total execution time in real seconds: %G%
6020024 Total execution time in CPU seconds: %G%
6020025 *** Summary of OUTPUT2 File Translation
6020026 %I% Nodes Translated.
6020027 %I% Elements Translated.
6020028 %I% Coordinate Frames Translated.
6020029 %I% Nodal Result Vectors Translated.
6020030 %I% Elemental Result Scalars Translated.
6020031 %I% Elemental Result Vectors Translated.
6020032 %I% Elemental Result Tensors Translated.
6020033 *** End of Translation Summary
6020034 No OUTPUT2 file was specified for translation. Please, select a file through the Select
Results File form before translating.
1958 PCL Reference Manual
Introduction
6020036 An error has occurred translating the neutral format OUTPUT2 file, "%A%", to binary.
Translation will be aborted.
6020038 The specified OUTPUT2 file, "%A%", is in text format and must be converted into
binary format prior to translation. The new binary OUTPUT2 file will be named
"%A%". Time will be saved in subsequent translations if this new binary OUTPUT2
file is specified instead of the text OUTPUT2 file.
6020039 Unable to obtain a mapping definition to map p-element results for element %I%.
6020040
Mapping results from p-element VU mesh to %I% Patran elements.
6020041 Element %I% does not have the required 3 x 3 x 3 VU mesh so results can not be
mapped back to Patran elements. These results can be processed by reading both model
6020060 Importing Node Results. %I% Scalars %I% Vectors %I% Tensors.
6020061 Importing Element Results. %I% Scalars %I% Vectors %I% Tensors.
6020062 Unable to get PHBDY data for CHBDY %I%
6020063 Unable to get area for CHBDY %I%
6020064 Unable to assign CHBDY heat to node %I%
6020065 Illegal vu-element type %I%
6020066 Error adding %A% result to the database. Status = %I% Entity ID = %I%.
6020067 Unable to import results for CHBDY element %I%
6020068 Results can not be imported for CHBDYE elements.
6020069 Error initializing duplicate result hash table.
6020070 Unable to get VU element for VU grid %I%
6020071
Grid Point Force Balance data must be written to an open Patran database.
6020072 Unable to translate OGPFB for element %I%
6020073 *** ERROR: Importing coordinate system %I%. Defining points are at the same
location or are collinear within the tolerance defined by "Division Tolerance".
6020074 This OUTPUT2 file cannot be converted to a flat file. This data must be written to an
open Patran database.
6020075 Shape change vector created from modified node locations.
6020076 Error accessing original model data when importing new, modified shape.
6020077 Creating objective function, maximum constraint and design variable global variables
for design cycle %I%.
6022001
Messages output from the Patran %A% input deck translator ( %A% %A% ) on %A%
at %A%.
6022002 Unable to open the MSC Nastran input file %A%.
6022003 The MSC Nastran input file, %A%, has been successfully opened.
6022004
MSC Nastran input file created by the Patran %A% input file translator ( %A% %A%
) on %A% at %A%.
6022005 Reading model information from the specified database, %A%.
6022006 Unable to open the specified database, %A%.
6022007 Translating %I% elements from the element property region %A%.
6022008 Translating %I% nodes from group : %A%.
6022009 Translating %I% nodes from the entire model.
6022010 Translating %I% referenced coordinate frames.
1960 PCL Reference Manual
Introduction
6022041 Load and boundary condition data may be inaccurate due to the fact that loads were not
evaluated from within Patran. To ensure the accuracy of load and boundary condition
data, evaluate all loads from within Patran by either submitting the analysis using the
standard Analysis forms or typing in the following command into the Patran command
6022061 ** ERROR: A Force LBC has been applied to p-element node %I% which is not
translated as a MSC Nastran GRID.
6022062 ** ERROR: A Temperature LBC has been applied to p-element node %I% which is not
translated as a MSC Nastran GRID.
6022063 Multiple boundary conditions not allowed for this Solution Sequence with versions less
than 68.
6022064 The analysis preference is not set to MSC Nastran.
6022065 The subcase "%A%" already exists.
6022066 The "%A%" output request is not supported in version %I% of the analysis code.
6022067 ** WARNING: LBC set %A% has no entities in its application region.
6022068 Subcase Name is "blank".
6022069 The name for load case "%A%" cannot be processed, because it contains more than 75
characters. Please shorten the name of this load case.
6022070 Subcase "%A%" already exists. Do you wish to delete the existing subcase and create
a new one?
6022071 Subcase "%A%" cannot be processed.
6022072 Solution sequence "%A%" is not supported.
6022073 Subcase "%A%" does not have a load case and cannot be associated to the job.
6022074 Subcase "%A%" could not be associated to the job.
6022075 The default subcase has been deleted. A subcase must be selected for this job.
6022076 %I% could not be entered into the database for the "%A%" parameter.
6022077 "%A%" could not be entered into the database for the "%A%" parameter.
6022078 %G% could not be entered into the database for the "%A%" parameter.
6022079 The following error occurred while %A%.
6022080 Only one static subcase can be specified with this Solution Sequence. The buckling
subcase will be generated automatically.
6022081 The gap element with ID %I% has zero length. The "Gap Orientation" on the Element
Properties form must specify a coordinate frame id for this element.
6022082 The order of the subcases that have already been analyzed should be maintained when
performing a restart for this solution sequence.
6022083 This request will be ignored by the analysis code unless 2D and/or 3D elements are
added to the model.
6022084 The inertial load set "%A%" cannot be translated, because it varies spatially. The
analysis code does not support spatially varying inertial loads.
6022085 At most nine GRAV entries can be used in a given run. The gravity loads for this job
exceed this limit, because they reference a coordinate system that is not rectangular.
6022086 An error has occurred while trying to associate the subcases to the job.
Chapter 11: Status Messages 1963
Introduction
6022087 *** WARNING: The p elements in superelement <%A%> do not have internal nodes.
Superelement is not created.
6022088 The selected result type already exists.
6022089 The checksum could not be determined for this machine.
6022090 The ENDDATA bulk data delimiter does not exist in the input file.
6022091 The BEGIN BULK case control delimiter does not exist in the input file.
6022092 The input file "%A%" could not be opened to determine the checksum.
6022093 The input file "%A%" could not be opened to write the checksum.
6022094 The checksum could not be determined, because this platform is not supported by the
checksum code.
6022095 The following files exist for the current job name, %A%. These files are %A%. Do you
want to delete these files?
6022096 The associated jobfiles were deleted successfully.
6022097 Unable to open the new message file "%A%". Translation messages will be written to
"standard output".
6022098 A node id must be specified in the "Node i.d. for Wt. Gener." databox when Inertia
Relief is selected.
6022099
A license could not be obtained for the Patran MSC Nastran translator.
6022100 The FEEDGE with ID = %I% is invalid.
6022101 Translating %I% p-element FEFACE's.
6022102 There is a problem with the number of fields on the %A% card.
6022103 Translating distributed loads in load set : %A%.
6022104 The shape of element ID = %I% is not recognized.
6022105 The connectivity is not available for element ID = %I%.
6022106 The magnitude of this vector is zero.
6022107 The method could not be determined for the GMLOAD.
6022108 The values for load set "%A%" are discontinuous at node ID = %I%.
6022109 Writing contact lbcs for Load Case: %A%.
6022110 *** ERROR: Cannot create CORD2R for slide plane, since all nodes on slideline are
collinear and parallel to the Master-to-Slave vector for Load Case: %A%.
6022111 *** WARNING: Removing node %I% from slave slideline, since it is also on the
master slideline for LBC set %A%.
6022112 *** ERROR: There are no nodes on slideline for LBC set %A%.
6022113 This translation will produce Bulk Data File entries for region %A% that are not
supported by the specified MSC Nastran VERSION (%A%).
1964 PCL Reference Manual
Introduction
6022114 An error occurred while processing the element property data for region %A%. Check
the data for this property region for valid entries. Translation terminating.
6022115 Beam sections are not supported for MSC Nastran version %A%. Property set %A%
will be created using PBAR or PBEAM commands rather than PBARL or PBEAML
commands.
6022116 The element ID = %I% is axisymmetric and must be in the XZ plane.
6022117 The node ID = %I% is referenced in the connectivity for element ID = %I%, but it does
not exist.
6022118 The element ID = %I% has a zero edge length.
6022119 The distributed edge load on element ID = %I% was ignored.
6022120 The transformation matrix could not be determined for element ID = %I%. The
distributed edge load on this element was ignored.
6022121 The distributed edge moment is not supported for axisymmetric elements. The load on
element ID = %I% was ignored.
6022122 Translating initial temperatures in load set : %A%.
6022123 Translating constant temperature boundary conditions in load set : %A%.
6022124 Translating nodal heat sources in load set : %A%.
6022125 Translating volumetric heat sources in load set : %A%.
6022126 Translating directional heat flux in load set : %A%.
6022127 Translating normal heat flux in load set : %A%.
6022128 Translating free convection in load set : %A%.
6022129 Translating tube flow convection in load set : %A%.
6022130 Translating radiation to ambient in load set : %A%.
6022131 Translating %I% SPOINT's.
6022132 Translating radiation enclosures in load set : %A%.
6022133 The normal to edge %I% on element ID = %I% could not be determined.
6022134 Directional flux was not specified.
6022135 Directional flux incident vector or time dependent direction cosines have not been
defined.
6022136 The material orientation for some elements could not be found. Redefine the material
orientation.
6022137 The Distributed Moments on p-element beams and shells is not supported at this time.
Do you wish to continue the analysis?
6022138 The PIN FLAGS on p-element beams are not supported.
6022139 There are no GEOMx blocks on the OUTPUT2 file. Post processing of heat fluxes for
convection and radiation boundary conditions will not be possible.
Chapter 11: Status Messages 1965
Introduction
6022140 The p-formulation beam and shell elements are supported for version 69 and above of
MSC Nastran. Do you want to submit this analysis?
6022141 For Equivalent Section Shells using laminated materials, the membrane and bending
materials cannot be the same name. Make two copies of the laminated material and use
them for membrane and bending separately.
6022142 %I% property regions translated.
6022143 The Node Id is greater than 99999999.
6022144 The MAT8 Id is greater than 999999.
6022145 *** Error: %A% vector is a zero vector.
6022146 *** Error: The Boundary Nodes are incorrect for superelement <%A%>.
6022147 *** Error: The Scale Factors on Load Sets and on Load Case are not supported for MSC
Nastran Thermal Analysis.
6022148 *** Beam Section Dimension error in element property region "%A%". Check
definition of beam section dimensions. MSC Nastran error code is %I%. See
MSC.Nastran Reference Manual for additional information on error code.
6022149 **WARNING: The midside nodes on curved edges of some cubic p-elements have
been adjusted so that the edges of the adjacent elements are C1 continuous. The change
applies to HEX32, WEDGE24, TET16, QUAD12, QUAD16 and TRIA9 p-element
types.
6022150 **ERROR: The property set "%A%" must have required properties defined. Property
set and region elements not translated.
6022151 The material density for material "%A%" is missing for the "Minimum Weight" design
objective. Density is set to 1.0.
6022153 The coordinate frame specified for Load Set "%A%" (CID %I%) conflicts with the
analysis coordinate frame defined on the following %I% nodes: %A%. Do you want to
continue with analysis?
6022154 The coordinate frame specified for Load Set "%A%" (CID %I%) conflicts with the
analysis coordinate frame defined on the following %I% nodes: %A%.
6022155 The property "%A%" is not supported as a Design Variable.
6022156 The temperature on solids in loadset "%A%" is not supported.
6022157 The multiple MATS1 cards for nonlinear analysis are not allowed.
6022158 **WARNING: The surface elements with midside nodes are ignored in Duct Flow
LBC.
6022159 Writing interface element lbcs.
6022160 The offsets in the residual structure are not supported for Non Linear analysis. Check
the property set <%A%>.
6022161 The encoded ids for some LoadBCs are identical. Make sure that all those LoadsBCs
are part of the loadcase if any one of them is used in the loadcase.
1966 PCL Reference Manual
Introduction
6022162 The "AUTOSPC" is turned "ON" for warping Nodes. Do you want to continue?
6022163 H element found in interface element %A%. Currently MSC Nastran interface element
only supports p elements.
6022164 Branch was found in curve interface element %A% at node %I%. This is not supported
by MSC Nastran.
6022165 Multiple curve segments were found in curve interface element %A%. This is not
supported by MSC Nastran.
6022166 Single node curve was found in interface element %A%. This is not supported by MSC
Nastran.
6022167 The function defined in field "%A%" as design variable is either nonlinear or is not of
the valid linear format. The function must be of the following form:
"c0+c1*d1+c2*d2+....."
6022168 The interface element %A% has no node in it.
6022169 More than 6 subdomains found in interface element %A%. Only the first 6 subdomains
are used, as supported by MSC Nastran.
6022170 Loop found in curve interface element %A%. This is not supported by MSC Nastran.
6022171 The PBEAML for sizing optimization is only supported for constant cross section.
6022172
Patran currently uses the spatial distribution of loading from the first selected subcase
for all subsequent subcases. This will be used in combination with the frequency
function from the currently selected subcase. If a different spatial distribution of
loading is intended for this subcase, this subcase should not be incorporated into a
multi-subcase run.
6022173
Patran currently uses the spatial distribution of loading from the first selected subcase
for all subsequent subcases. This will be used in combination with the time function
from the currently selected subcase. If a different spatial distribution of loading is
intended for this subcase, this subcase should not be incorporated into a multi-subcase
run.
6022174
Patran currently uses the spatial distribution of loading and the modal damping from the
first selected subcase for all subsequent subcases. The load distribution will be used in
combination with the frequency function from the currently selected subcase. If a
different spatial distribution of loading or a different specification of modal damping is
intended for this subcase, this subcase should not be incorporated into a multi-subcase
run.
6022175
Patran currently uses the spatial distribution of loading and the modal damping from the
first selected subcase for all subsequent subcases. The load distribution will be used in
combination with the time function from the currently selected subcase. If a different
spatial distribution of loading or a different specification of modal damping is intended
for this subcase, this subcase should not be incorporated into a multi-subcase run.
Chapter 11: Status Messages 1967
Introduction
6026068 The subcase(s) %A% do not have the same Control Devices as the selected
SuperGroup. Should they be removed from the Selected Subcase list? (If NO then the
selected SuperGroup will not be set.)
6026069 The subcase(s) %A% do not have the same Control Devices as the selected SuperGroup
for the new job. Should they be removed from the Selected Subcase list? (If NO then
the selected SuperGroup will not be set.)
6026070 Some of the selected nodes belong to the group %A%. This group is not a Structural
Group. Please check the list of nodes that were selected.
6026071 The selected elements belong to more than one Surface/Body. Please make sure to only
select elements that belong to one Surface/Body.
6026072 The selected elements all belong to the %A% Element Property set which is either not
an Aero Element Property or is an Aero Element Property of the wrong type. Please
select only Aero elements of the correct type.
6026073 One or more selected elements are not aerodynamic. Please select only Aero elements.
6026074 The effectiveness value should be a positive value.
6026075 The Control Device name %A% is already in use or is invalid.
6026076 The Control Device name %A% does not exist.
6026077 The Spline name %A% is already in use or is invalid.
6026078 The Spline name %A% does not exist.
6026079 The %A% listbox has no items highlighted. Please select an item in the listbox in order
to continue.
6026080 The Next Elem ID Increment value is invalid. The number must be 4 or greater.
6026081 The subcase %A% is not of method type %A% and therefore will not be added to the
Subcases Selected listbox.
6026082 The Control Devices for the subcase %A% do not match those for the current Aero
Model. Please update the subcase.
6026083 An invalid Action of %A% was specified.
6026084 An invalid Object of %A% was specified.
6026085 An invalid Method of %A% was specified.
6026086 No Result Cases were selected.
6026087 No Result Types were selected.
6026088 The control devices for the selected subcase do not match the current SuperGroup
control devices. Selection of the Trim Parameters button will cause the trim parameters
to be reset to their default state.
6026089 No Splines were selected.
6026090 Global Data values are missing.
6026091 The Import File Name is missing.
Chapter 11: Status Messages 1971
Introduction
6026092 The entered Import File Name %A% does not exist.
6026100 Specified file %A% is a Directory
6026101 Unable to write to file: %A%
6026102 File %A% already exists. Do you wish to overwrite it?
6026103 Unable to verify that the file %A% exists. Do you want to continue?
6026104 Unable to find Result Quantity $A%.
6031001 The control file name must be specified as the first command-line argument for this
program.
6031002
Messages output from the Patran %A% input deck file translator ( %A% %A% ) on
%A% at %A%.
6031003 End of ANSYS input file translation.
6031004 A jobfile for the wrong translator was submitted to the ANSYS results translator. The
text of the line in the jobfile is %A%.
6031005 The translator name was not specified in the jobfile. Translation terminating.
6031006 No DATABASE specification was found in the jobfile.
6031007 No JOBNAME specification was found in the jobfile.
6031008 No OBJECT specification was found in the jobfile.
6031009 An incorrect value for OBJECT was found in the jobfile. It must be ENTIRE_MODEL,
SUPERELEMENT, or GROUP
6031010 Unable to open the specified database, %A%.
6031011 Reading model information from the specified database, %A%.
6031012
ANSYS input file created by the Patran %A% input file translator ( %A% %A% ) on
%A% at %A%.
6031013 The ANSYS input file, %A%, has been successfully opened.
6031014 Unable to open the ANSYS input file %A%.
6031015 Unable to find the parameter %A% in the list of parameters.
6031016 The parameter %A% was not found in the jobfile. Check ANALYSIS forms to ensure
that a value was defined for this parameter.
6031017 *WARNING* The ANSYS RELEASE number parameter was either not found or had
a bad value. Check your PREP7 input deck to ensure it is for the correct release of
ANSYS.
6031018 No element properties were detected in the database.
6031019 The translation stopped while %A%.
6031020 No materials were detected in the database.
6031021 The array that contains the %A% is incorrectly dimensioned to %I%.
1972 PCL Reference Manual
Introduction
6031048 The property in position %I% of the PLY_MEM array has not been accounted for in the
routine that retrieves ply data.
6031049 The elements in region "%A%" are of STIF type %I% which requires a laminated
material.
6031050 The element property region id %I% was not found in the list of regions in the database.
6031051 The solution type specified is not supported.
6031052 The orientation node %I% for element %I% was not found in the database.
6031053
No map was found for mapping the Patran faces and edges to the ANSYS face numbers
for STIF %I% elements.
6031054 *WARNING* A loading was applied to a face or edge that is not supported in ANSYS.
LBC case is %A%. Translation is continuing without this loading.
6031055 *WARNING* HEAT FLUX is not supported by ANSYS Release 4.X. You must have
ANSYS Release 5.X to use HEAT FLUX. Translation is continuing without this
loading.
6031056 *WARNING* Non-zero coefficients are ignored in MPC # %I%.
6031057
Constraint equations generated by Patran "%A%" MPC # %I%.
6031058 Error translating mpc # %I%. Re-check mpc geometry.
6031059
DOF was required at node %I% for Patran MPC #.
6031060 The number of total nodes in an "%A%" MPC must be %I% times the number of
dependent nodes.
6031061 Unknown node %I% referenced in "%A%" type MPC.
6031062 Unknown coordinate frame %I% referenced by MPC %I%.
6031063 MPC # %I% not translated.
6031064 The %A% %I% was not found in the search.
6031065 The MPC that has an id of %I% will not appear in the input deck.
6031066 No MPCs were detected in the database.
6031067 The translation must be resubmitted from the Analysis Form.
6031068 An unrecognized degree of freedom was found while %A%.
6031069 No independent term was found for MPC number %I%, of type %A%.
6031070 More than the allowed number of %A% were specified for the MPC set. The maximum
number allowed for a %A% type mpc is %I%.
6031071 *WARNING* An unsupported MPC type was detected for MPC number %I%.
Translation continuing without this MPC.
6031072 No dependent term was found for MPC number %I%, of type %A%.
6031073 The field %A% is not a material field. Translation terminated.
1974 PCL Reference Manual
Introduction
6031074 The field %A% has more TEMPERATURE values than the %I% allowed. Translation
terminated.
6031075 The field %A% has more DATA POINTS than the %I% allowed. Translation
terminated.
6031076 *WARNING* The origin point has been removed from the definition of field %A% for
entry into the ANSYS nonlinear material table.
6031077 Translating %I% %A%
6031078 Writing data for Load Case %A%.
6031079 Writing %A% Solution Parameters.
6031080 Preparing to write %I% Elements in %I% Region(s).
6031081 Writing %I% Elements in Subregion %I% of Region %A%.
6031082 *** ERROR: Could not determine element type in target region for Lbc: %A%.
6031083 *** ERROR: Could not determine element type in contact region for Lbc: %A%.
6031084 The selected analysis code in the database is not ANSYS or ANSYS 5. Please update
your Analysis Preference setting.
6031085 *WARNING* No supported element type was found for the element(s) with shape
%A%%I%. Translation is continuing without the affected elements.
6031086 Determining information for region "%A%".
6031087 The element's type or its shape was not found for element id %I%.
6031088 *WARNING* Elements or their shapes were not found for a load set. The LBC case is
"%A%". Translation is continuing without this load for the affected element(s).
6031089 *** ERROR: Check the Contact Lbc %A%.
6031090 The Vector pointing from Target to the Contact surface must be defined.
6035001 ANSYS element STIF%I% is not supported by the translator. Execution proceeding
without this element type.
6035002 Input Results File is From Pre 4.2 Version of ANSYS. Translation Stopped.
6035003 Illegal STIF number (%I%) detected in ANSYS results file. Execution stopped.
6035004 Error initializing results database for element type STIF%I%.
6035005 Error allocating in-core virtual memory. Translation Stopped.
6035006
Message file created by the Patran ANSYS RESULTS translator ( %A% %A% ) on
%A% at %A%.
6035007 Translation from ANSYS results file "%A%".
6035008 ANSYS results file was created by: %A%.
6035009 Error translating ANSYS Reaction Force data block. Translation Stopped.
6035010 Error Adding ANSYS Reaction Force data to database. Translation Stopped.
Chapter 11: Status Messages 1975
Introduction
6035011 The element shape is not properly defined for the element type %I%. ISHAPE = %I%.
6035012 Error translating displacements. Translation Stopped
6035013 A user defined Coordinate Frame was detected for element type %I% with CID = %I%.
If the model was not created in Patran, you will have to create the coordinate frame
before attempting to display your results.
6035014 A jobfile for the wrong translator was submitted to the ANSYS results translator. The
text of the line in the jobfile is %A%.
6035015 The translator name was not specified in the jobfile. Translation terminating.
6035016 The element number %I% of type STIF No. = %I% with shape = %A% is not
supported. Translation is continuing without this element.
6035017 Error while translating local coordinate systems. Translation Stopped.
6035018 An Unsupported Toroidal coordinate system (Number %I%) was encountered. It was
translated as a rectangular coordinate system. NOTE: Results referring to this
coordinate system may be improperly displayed.
6035019 An Unsupported Elliptical %A% coordinate system (Number %I%) was encountered.
It was translated as a %A% coordinate system. NOTE: Results referring to this
coordinate system may be improperly displayed.
6035020 Definition of element top and bottom has been specified by the user. Bottom is now at
the bottom of layer %I%, and Top is now at the top of layer %I% for Element Number
%I%.
6035021 KEYOPT9 was nonzero for Element Number %I%. Top and Bottom values are now at
the middle of the top and bottom layers.
6035022 No DATABASE specification was found in the jobfile.
6035023 No JOBNAME specification was found in the jobfile.
6035024 No RESULTS FILE specification was found in the jobfile.
6035025 No OBJECT specification was found in the jobfile.
6035026 An incorrect value for OBJECT was found in the jobfile. It must be RESULT
ENTITIES, MODEL DATA, or BOTH
6035027 The following database error occurred while creating the %A%.
6035028 The number of element results is incorrectly set to %I% in the element results definition
table for STIF number %I%.
6035029 The array that contains the %A% is incorrectly dimensioned to %I%.
6035030 An error occurred while allocating in-core memory for %A%.
6035031 The %I%th entry in the results definition table was not found for STIF number %I%.
6035032 The configuration of element %I% is currently not supported for STIF number %I%.
6035033 End of ANSYS results file translation. -----
6035034 Total execution time in real seconds: %G%
1976 PCL Reference Manual
Introduction
6035062 Retrieving data for %I% %A% from the ANSYS results file.
6035063 *WARNING*: Results Import for the ANSYS Element Type, STIF%I%, is not
currently supported. Translation is continuing without element results for this element
type.
6035064 ERROR reading ANSYS results file, GROUP 3 data.
6035065 ERROR reading ANSYS results file, GROUP 4 data.
6035066 ERROR: ANSYS requires that the combination of file name and extension be 50
characters or less in length. Your file name %A% is too long. Please rename your file
to fit the ANSYS requirements.
6037001 Only 50 output requests may be defined. Please delete excess requests.
6037002 An improper %A% was selected. Please reselect.
6037003 The fully defined results file name exceeds the 50 character limit imposed by ANSYS
Revision 5. Please create a symbolic link in the current directory or copy the results file
to the current directory then resubmit the job.
6037004 The use of fields is not allowed in the definition of %A%. Please redefine input.
6037005 Only 10 convergence criteria may be defined. Please delete excess requests.
6041001 *** ERROR: Can't open the Database.
6041002 *** ERROR: Can't open the Error message file.
6041003 *** ERROR: Error opening ABAQUS .inp file.
6041004 *** ERROR: Erroneous Database or Void of nodes.
6041006 *** ERROR: Erroneous line_string "%A%" in job_file.
6041007 *** ERROR: The job_card for %A% is missing.
6041008 *** ERROR: Group_id for %A% not found in Data_base. Translation commenced for
Entire model.
6041009 Translation commenced for group <%A%>.
6041010 Translation commenced for the Entire_Model.
6041011 *** ERROR: Data_base error, %A%
6041012 *** ERROR: Data_base error, %A% , ID = %I%
6041013 *** ERROR: Element %I% is not defined right (no shape).
6041014 %A%
6041015 *** ERROR: The Model/Group void of NODES.
6041016 *** ERROR: The Model/Group void of ELEMENTS.
6041017 *** ERROR: Error in fetching node_ids.
6041019 *** ERROR: Regions are not assigned to the elements.
6041020 *** ERROR: Error getting coordinate frame %I%.
6041021 *** ERROR: Error in writing to .inp file.
1978 PCL Reference Manual
Introduction
6041028 *** ERROR: Element %I% has unmatched Shape, Nodes, and allowable property.
6041030 *** ERROR: Error getting prop_values in the region.
6041031 *** ERROR: Element %I% has no Property Definition.
6041032 *** ERROR: Data model has no regions defined.
6041033 *** WARNING No properties found in the region %I%.
6041034 *** ERROR: Non_linear material not supported for the beam sections in region %A%.
6041035 *** ERROR: Error closing .msg file.
6041036 <%I8% Nodes> translated.
6041037 <%I8% Coordinate Frames> translated.
6041038 <%I8% Elements> translated.
6041039 <%A8%> elements of <region %I%> in property set <%A%> translated.
6041040 <%A%> translating *Beam_General_Section properties.
6041041 <%A%> translating *Beam_Section properties for beam in_plane.
6041042 <%A%> translating *Beam_Section properties for beam in_space.
6041043 <%A%> translating *Shell_General_Section properties.
6041044 <%A%> translating *Shell_Section properties.
6041045 <%A%> translating *Shell_Section properties for composites.
6041046 <%A%> translating *Solid_Section properties.
6041047 <%A%> translating *Mass and/or *Rotary_Inertia properties.
6041048 <%A%> translating *Spring and/or *Dashpot properties.
6041049 <%A%> translating *Interface properties.
6041050 <%A%> translating *Interface properties for thermal elements.
6041051 *** ERROR: %A%_ID %I% exceeds 8_Digit limit. Translation stopped.
6041052 *** ERROR: Element %I% has no Type and Property definition. Translated as %A%
element.
6041053 *** ERROR: Error string <%A%> found reading loadcase.
6041054 *** WARNING Region %I% has no elements in it. No properties translated.
6041055 *** ERROR: Error<%I%> in <%A%> call
6041056 *** ERROR: Error counting lbcs in <%A%> load_case.
6041057 *** ERROR: Error in <DB_GET_LOAD_CASE> in %A% load_case.
6041058 *** ERROR: Error fetching edges for element %I%.
6041059 *** ERROR: Error fetching faces for element %I%.
6041060 *** WARNING No properties found in <%I%> region.
6041061 *** ERROR: Load_type_id <%I%> not supported.
Chapter 11: Status Messages 1979
Introduction
6041062 *** ERROR: Loads_types for Structural and Thermal analysis supported only.
6041063 *** ERROR: Node <%I%> not defined for load <%A%>
6041064 *** ERROR: Element <%I%> not defined for load <%A%>
6041065 Reading Solution params for Step <%I%>.
6041066 Reading Output requests for Step <%I%>.
6041067 *** WARNING: The loadcase <%A%> has no loads or boundary conditions.
6041068 *** ERROR: The cid <%I%> for load_type <%A%> is not associated with node
<%I%>.
6041069 Translating <%A%> for loadset <%A%>
6041070 *** ERROR: Error fetching field attributes in DB_ call <%A%> for field_id <%I%>
6041071 *** ERROR: Field <%A%> is not tabular.
6041072 *** ERROR: Field <%A%> is not a time_function.
6041073 <%A%> field being translated.
6041074 *** ERROR: Load transformation for <%A%> from cid <%I%> to global at node
<%I%> from unsuccessful. translation continuing.
6041075 Load <%A%> transformed from cid <%I%> to global at node <%I%>.
6041076 *** ERROR: Element <%I%> has unidentified face_number associated with the load.
6041077 * There are no MPCs defined in the model.
6041078 *** ERROR: Material name not found in the data_base.
6041079 <%A%> material being translated.
6041080 *** ERROR: Density must be defined for Specific Heat definition.
6041081 <%I8% mpcs> translated.
6041082 *** WARNING Material Property <%A%> not defined.
6041083 <%A%> mpc_type being translated.
6041084 *** ERROR: MPC node_id <%I%> is double dependent.
6041085 *** ERROR: MPC_node <%I%> has *TRANSFORM definition.
6041086 *** ERROR: Load type <%A%> not supported.
6041087 <%A%> translating *Interface props for ISL or IRS elements.
6041088 <Slide Lines> being translated.
6041089 <Rigid Surfaces> being translated.
6041090 <%A%> BASE motion table translated.
6041091 <%A%> PSD definition translated
6041092 <%A%> Spectrum translated.
6041093 <%A%> Procedure being translated.
1980 PCL Reference Manual
Introduction
6041094 *** ERROR: The film coefficient variation with time is not allowed in <%A%>.
6041095 *** ERROR: Element Variable loads not supported for <%A%> load type.
6041096 Needed file specification missing! The full name of the jobfile must be specified as the
first command-line argument to this program.
6041097 *** ERROR: Field properties not supported for <%A%>
6041098 <%A%> translating *gap properties.
6041099 *** ERROR: Element <%A%, ID=%I%> has negative normal. Please correct the
element.
6041100 <%I8% %A%> read from the database.
6041101 <%I8% Nsets> Translated.
6041102 *** ERROR: <%A%> MPC type is not supported.
6041103 *** ERROR: Material <%A%> is void of material data.
6041104 *** ERROR: The %A% is not supported.
6041105 *** WARNING The cid <%I%> for Displacement <%A%> is not associated with node
<%I%>. The Displacements are defined in the Global Coordinate frame.
6041106 *** ERROR: The material defined is not Laminate.
6041107 *** WARNING The load on node_id <%I%> is transformed to the analysis CID
<%I%> associated with this node.
6041108 Translating <%A%> Material Properties.
6041109 *** ERROR: MPC <%I%> has doubly defined node <%I%>. Translation skipped.
6041110 *** WARNING: The data_base was created with <%A%> analysis code. Total
model_data translation is not guaranteed. Please check the input file.
6041111 *** ERROR: MPC <%A%> is supported in ABAQUS V5.1 only.
6041112 *** ERROR: Procedure Type <%A%> not supported.
6041113 <%I%> Step(s) have been translated.
6041114 Translation Ended with Status = %I%
6041115 *** WARNING Load Set <%A%> not valid for this step.
6041116 *** ERROR: Arbitrary Section has inconsistent definition. Coord1(n)=%I%,
Coord2(n)=%I%, Thickness(n-1)=%I%.
6041117 *** ERROR: %A% must be defined in a field.
6041118 *** ERROR: %I% exceeds the maximum number of terms allowed in prony series
(13).
6041119 *** ERROR: %A%_ID %I% exceeds 7_Digit limit. Translation stopped.
6041120 *** ERROR: OFFSET for a laminate not allowed. Please redefine the material
<%A%>.
Chapter 11: Status Messages 1981
Introduction
6041121 *** ERROR: The Combined Test Data must be defined on same time scale. Please
correct the field <%A%>.
6041122 *** WARNING The loads & boundary conditions applied to the geometry may not be
correct. Please submit the translation from the Analysis Form first.
6041123 The old jobname for restart and current jobname are same. Please enter a unique
jobname.
6041124 *** ERROR: The mpc type <%A%> must have <%I%> independent nodes, mpc_id =
%I%.
6041125 *** ERROR: Constant Term is not supported for mpc type <%A%>, mpc_id = %I%.
6041126 *** ERROR: Respective set name for ID=%I% not found in the table.
6041127 <%I8% Groups> translated.
6041128 *** ERROR: The ELSET names <%A%> & <%A%> for contact elements and the the
contact surfaces element properties do not match. Please input the matching ELSET
names.
6041129 *** WARNING The ELSET name <%A%> already exists. Changed to ELSET name
<%A%>.
6041130 *** ERROR: The <%A%> result for element type <%A%> not supported.
6041131 *** ERROR: The Temperature Results File name <%A%> should not be greater than
31 characters.
6041132 <%I8% Dummy MPCs> translated for rigid surface <%A%>.
6041133 Translating <%A%> load being read from file <%A%>.
6041134 *** WARNING: The coordinate transformation of element results is not supported for
the elements associated with local orientation. Please use As-Is, the default coordinate
transformation option when postprocessing results.
6041135 *** WARNING: The coordinate transformation of element results for shells and
membranes is not supported. Please use As-Is, the default coordinate transformation
option when postprocessing results.
6041136 *** ERROR: The Reference Node for the rigid surface should not be one of the nodes
associated with the rigid surface elements. Please use an unassociated node for
reference.
6041137 *** ERROR: The Latent Heat temperature fields for solidus and liquidus temperatures
should have exact number of cells and must have exactly the same values for Latent
Heat.
6041138 *** ERROR: The string <%A%> in the Keyword Input is longer than 80 characters.
6041139 *** ERROR: The laminate angles are not within the range of -90.0 and 90.0 degrees
for the property set <%A%>. Check the material.
6041140 The Mid Increment Residual should be specified for automatic time incrementing.
Fixed time increments will be used otherwise.
1982 PCL Reference Manual
Introduction
6045037 *** ERROR: The <Increment %I%> for <Step %I%> not found in the <%A%> file.
6045038 <Step(s) %I%, Increment(s) %I%> translated.
6045039 Superelement <%A%> with id <%I%> being translated.
6045040 *** ERROR: Superelement <%I%> not found.
6045041 *** ERROR: The number of words in the record exceed the <%I%> limit.
6045042 *** WARNING: Duplicate Node/Element found. Translation continued.
6045043 *** ERROR: The results filename <%A%> should end with .fil suffix. Rename the file.
6050000 MSC.Marc
6050001 The file named "%A%" could not be opened.
6050002 The control file name could not be determined.
6050003 The control file entry "%A%" could not be processed.
6050004 The results file translation is complete.
6050005 The node id %I% could not be found in the element's connectivity.
6050006 The element results could not be transformed because a node is missing from the
connectivity.
6050007 A label could not be generated for %A% %I%.
6050008 The element id %I% has a degenerate configuration that is not supported. The results
for this element will be translated; however, the locations within the element will not
be correct.
6050009 The total CPU time for this translation was %G% seconds.
6050010 A license could not be obtained for the MAC.Marc translator.
6051001 The value %I% is not valid for the maximum number of iterations. This has been
replaced with the default value of 3.
6051002 The tolerance type "%A%" is not recognized. This has been replaced with the default
tolerance type, "Total Residual".
6051003 The iteration procedure "%A%" is not recognized. This has been replaced with the
default iteration procedure, "Full Newton Raphson".
6051004 The value %G% is not valid for a convergence tolerance. This has been replaced with
the default value.
6055001 The end of the results file was unexpectedly encountered.
6055002 A record was encountered that could not be read from the results file.
6055003 The following error occurred while reading the title from the results file.
6055004 The following error occurred while reading parameter information from the results file.
6055005 The following error occurred while reading set information from the results file.
6055006 The following error occurred while reading the %I%th element postcode from the
results file.
Chapter 11: Status Messages 1985
Introduction
6055007 The following error occurred while reading connectivity for the %I%th element from
the results file.
6055008 The following error occurred while reading coordinates for the %I%th node from the
results file.
6055009 The following error occurred while reading data for the %I%th spring from the results
file.
6055010 The following error occurred while reading the node types from the results file.
6055011 The following error occurred while reading transformation number %I% from the
results file.
6055012 The following error occurred while reading data for set number %I% from the results
file.
6055013 The following error occurred while reading items for set number %I% from the results
file.
6055014 The following error occurred while reading the increment marker from the results file.
(previous inc.=%I%, previous subinc.=%I%)
6055015 The following error occurred while reading the increment data from the results file.
(previous inc.=%I%, previous subinc.=%I%)
6055016 The following error occurred while reading the increment data from the results file.
(current inc.=%I%, current subinc.=%I%)
6055017 The following error occurred while reading the distributed loads from the results file.
(current inc.=%I%, current subinc.=%I%)
6055018 The following error occurred while reading the forces for the %I%th spring from the
results file. (current inc.=%I%, current subinc.=%I%)
6055019 The following error occurred while reading the forces for the %I%th die from the
results file. (current inc.=%I%, current subinc.=%I%)
6055020 The following error occurred while reading the results for element id %I% from the
results file. (current inc.=%I%, current subinc.=%I%)
6055021 The following error occurred while reading the results for node id %I% from the results
file. (current inc.=%I%, current subinc.=%I%)
6055022 The translator is unable to read results files that have new non-incremental data.
6055023 The element type %I% is not supported. The results for element %I% cannot be
imported.
6055101 The following error occurred while creating the subcase title. (current inc.=%I%,
current subinc.=%I%)
6055102 The following error occurred while creating the element result type with %A% for its
primary label and %A% for its secondary label.
6055103 The following error occurred while creating the section position id for element layer
number %I%.
1986 PCL Reference Manual
Introduction
6055104 The following error occurred while creating the layer position id for element layer
number %I%.
6055105 The following error occurred while creating the nodal result type with %A% for its
primary label and %A% for its secondary label.
6055106 The following error occurred while creating the section position id for node layer
number %I%.
6055107 The following error occurred while creating the layer position id for node layer number
%I%.
6055108 The following error occurred while loading the scalar result(s) for node id %I%.
(current inc. =%I%, current subinc.=%I%).
6055109 The following error occurred while loading the vector result(s) for node id %I%.
(current inc. =%I%, current subinc.=%I%).
6055110 The following error occurred while loading the scalar result(s) for element id %I%.
(current inc.=%I%, current subinc.=%I%).
6055111 The following error occurred while loading the tensor result(s) for element id %I%.
(current inc.=%I%, current subinc.=%I%).
6055112 The following error occurred while associating the imaginary and real harmonic
stresses.
6055201 The length of a vector used to calculate the transformation is zero.
6055202 The vector from node i to node j has zero length.
6055203 The vector from node i to node k has zero length.
6055204 The vector normal to the surface has zero length.
6055205 The following error occurred while creating the coordinate transformation matrix for
element id %I%. (current inc.=%I%, current subinc.=%I%)
6055206 The gap direction cannot be determined for the element id = %I%.
6055301 This message file was created by %A% of the %A% translator on %A% at %A%.
6055302 The results file named "%A%" has been opened.
6055303 The database file named "%A%" has been opened.
6055304 The database file named "%A%" has been closed.
6055305 The load case "%A%" has been found or created.
6055306 The subcase "%A%" has been created.
6055307 The results have been translated for %I% elements.
6055308 The results have been translated for %I% nodes.
6055309 The result type "%A%, %A%" has been created.
6055310 The section position "%A%" has been created.
6055311 The control file named %A% has been closed.
Chapter 11: Status Messages 1987
Introduction
6055312 The subcase "%A%" has not been created because of filtering.
6056000 The translation has stopped during initialization.
6056001 The translation has stopped while extracting model data.
6056002 The translation stopped while determining the solution type.
6056004 The translation stopped while writing to the input file.
6056005 The error was detected while %A%.
6056006 The translation stopped while processing the output requests.
6056007 The translation stopped while processing the loads and boundary conditions.
6056008 The translation stopped while creating the model from the information contained in the
results file.
6057000 The array that contains the %A% is dimensioned incorrectly.
6057001 The string "%A%" was not found in the search.
6057002 This is not the %A% translator. The TRANSLATOR parameter of the control file does
not match the name of this translator.
6057003 The error occurred while extracting %A% from the database.
6057004 An error occurred while allocating in-core virtual memory for the %A%.
6057005 The selected analysis type in the database is is incompatible with the requested solution
type.
6057006 An error occurred while trying to extract a digit from a condensed code. The condensed
code is %I%, and the requested digit is %I%.
6057011 The control parameter %A% has been set to %A% and cannot be processed.
6057012 The field named %A% has more than one independent variable. It has been used
incorrectly to define time dependent loads or boundary conditions.
6057013 The error occurred while extracting %A% from the database for the material named
"%A%".
6057014 The error occurred while extracting %A% from the database for MPC id %I%.
6057015 Node id %I% was specified in an application region; however, it could not be found in
the model.
6057016 The selected analysis code in the database is not MSC.Marc.
6057017 The string "%A%" could not be right justified, because the specified number of
characters, %I%, is incorrect.
6057018 The card "%A%" cannot be written to the input deck.
6057019 The value "%G%" cannot be converted to a string in %A% for the requested number of
significant digits.
6057020 The data field width is set to %I%.
6057021 The number of significant digits is set to %I%.
1988 PCL Reference Manual
Introduction
6057022 The number of characters required for the %A% format overhead, %I%, is in error. The
number of significant digits used in the input deck may not be as requested.
6057023 The trailing zeroes were being stripped from the value "%A%".
6057024 The decimal point was not found in the value "%A%".
6057025 The interpolation was not successful at time %G%.
6057026 The number of entries requested on a data card is %I%.
6057027 The length of an arbitrary section branch is %G% which is less than the numerical
tolerance.
6057028 The number of nodes in the element connectivity table needs to be updated for element
type %I%.
6057029 A reference temperature must be entered for the material named "%A%".
6057030 The interpolation could not be performed because the table is empty.
6057031 The strain hardening is not defined at the reference temperature for the material named
"%A%".
6057032 The equivalent yield stress is negative for the material named "%A%".
6057033 The initial equivalent plastic strain must be zero for the work hardening curve used to
define the material named "%A%".
6057034 The work hardening slope is equal to zero at the first temperature for the material
named "%A%".
6057035 The load case "%A%" is time dependent and cannot be used to define the harmonic
loads and boundary conditions.
6057036 The analysis type %I% for increment %I% cannot be processed.
6057037 The load/boundary condition named "%A%" has an empty application region.
6057038 The translation must be resubmitted from the Analysis Form.
6057039 None of the nodes in the results file are attached to elements.
6057040 None of the element types in the model are supported.
6057041 *** ERROR: Could not determine element type in contact body for Load Case: %A%
6057042 *** ERROR: Unsupported element type used in contact body for Load Case: %A%
6057043 *** ERROR: Inconsistency between number of contact bodies in the load case and
number of bodies in the contact table. Contact table will not be written to the input file.
6057044 *** ERROR: Wrong number of entries in analysis parameter
"CONTACT_TABLE_SETS_COUNT". Contact table will not be written to the input
file.
6057045 *** ERROR: Wrong number of entries in analysis parameter
"CONTACT_LBC_SETS". Contact table will not be written to the input file.
6057046 *** ERROR: Contact table LBC set id (%I%) not found in the load case.
6057047 *** ERROR: Too many entities in the CONTACT TABLE for entity with LBC id %I%.
Chapter 11: Status Messages 1989
Introduction
6058000 An error occurred while closing the control file named %A%.
6058001 No element property regions were detected in the database. The element types,
properties, and connectivity will not appear in the input deck.
6058002 No elements were detected in the database.
6058003 The number of characters per machine word has been set incorrectly. It is assumed to
be four.
6058004 An error occurred while writing the %A% option to the in the input deck.
6058005 The %A% %I% was not found in the search.
6058007 There are not any parameters associated with the load set named "%A%" that can be
translated. This may have occurred while prioritizing the loads and boundary
conditions.
6058008 The element face id %I% is not in the face table.
6058009 The element edge id %I% is not in the edge table.
6058010 The element id %I% does not have any nodes associated with it and will not appear in
the input deck.
6058011 The connectivity for element id %I% contains node id %I% which does not exist.
6058012 Element type %I% does not exist in the translator's tables.
6058013 The value %I% cannot be processed for %A%.
6058014 There are not any element properties for the region named "%A%".
6058016 No materials were detected in the database.
6058017 The load case was not specified for this analysis.
6058018 The control file name must be specified as the first command-line argument for this
program.
6058019 Only one rotation axis can be specified for the model.
6058020 The magnitude of the angular velocity is zero.
6058022 The numerical tolerance is less than or equal to zero and has been changed to %E%.
6058023 The elastic properties are not activated for the material named "%A%". It will not
appear in the input deck.
6058024 The field named %A% is not tabular and cannot be used to define the "%A%". This
error was detected for "%A%".
6058025 The field named %A% does not contain any entries. The "%A%" cannot be processed
for "%A%".
6058026 The field named %A% has more than one independent variable. It has been used
incorrectly to define the material property "%A%" for the material named "%A%".
6058027 The rule of mixtures composite material named "%A%" has been treated as an
orthotropic material.
1990 PCL Reference Manual
Introduction
6058028 The element dimensionality is set to %I% for the load set named "%A%". It will not
appear in the input deck.
6058029 The control file parameter table needs to be updated. The element result "%A%" cannot
be processed.
6058030 The primary element result label table needs to be updated. The element result "%A%"
cannot be processed.
6058031 The secondary element result label table needs to be updated. The element result
"%A%" cannot be processed.
6058032 The element result table needs to be updated. The element result "%A%" cannot be
processed.
6058033 The value %G% cannot be processed for %A%.
6058034 The element post code directory needs to be updated. The element result index that
could not be found is %I%.
6058035 There were no degrees of freedom found for the "Tie DOFs" MPC whose id is %I% and
subordinate id is %I%. This MPC will not appear in the input deck.
6058036 The memory that contains the data for the load or boundary condition named "%A%"
has been sized incorrectly. It will not appear in the input deck.
6058037 The comment "%A%" could not be written to the input deck.
6058038 The components of displacement always refer to the analysis coordinate frame of the
node. The coordinate frame associated with the load or boundary condition named
"%A%" is ignored.
6058039 The centrifugal load cannot be spatially varying. The load set named "%A%" will not
appear in the input deck for this reason.
6058040 The element id list was not entered for the wave-front optimization.
6058041 The numerical tolerance is not small enough to be able to process %I% increments.
6058042 No nodes were detected in the database.
6058043 The command-line arguments must include the control file name (ie. the "jba" file
name) or the database file name and the jobname.
6058044 The shape of element %I% was not defined in the translator's tables.
6059000 MPCs of type "%A%" cannot be translated, because their definition has been altered.
6059001 The element that has an id of %I% will not appear in the input deck.
6059002 The MPC that has an id of %I% will not appear in the input deck.
6059003 The load set named "%A%" will not appear in the input deck.
6059004 No load or boundary conditions were detected in the database.
6059005 No MPCs were detected in the database.
6059006 The %A% is currently not supported.
6059007 The MSC.Marc input file translation is complete.
Chapter 11: Status Messages 1991
Introduction
6059008 The connectivity for %I% elements has been written to the input file.
6059009 The coordinates for %I% nodes have been written to the input file.
6059010 The element properties have been written to the input file for the region named "%A%".
6059011 The output requests have been written to the input file.
6059012 The properties for the material named "%A%" have been written to the input file.
6059013 The information for %I% MPCs has been written to the input file.
6059014 The time independent load and boundary conditions have been written to the input file.
6059015 The load case name "%A%" has been read from the control file.
6059016 The control parameters have been read from the file named %A%.
6059017 The input file named "%A%" has been created.
6059018 The input file named "%A%" has been closed.
6059019 The material orientation has been written to the input file for the region named "%A%".
6059020 The time dependent load and boundary conditions have been written to the input file.
6059021 The control parameter %A% is set to %A%.
6059022 The control parameter %A% is set to %E%.
6059023 The control parameter %A% is set to %I%.
6059024 An error was detected while trying to expand this list "%A%".
6059025 The flat file named "%A%" has been created.
6059026 The flat file named "%A%" has been closed.
6059027 There are %I% new elements that have been created in the group named "%A%".
6059028 There are %I% new nodes that have been created in the group named "%A%".
6059029 There are %I% new coordinate frames that have been created.
6059501 The results file name must be entered on Restart Parameters form before this job can be
submitted.
6059502 The restart file name must be entered on Restart Parameters form before this job can be
submitted.
6059503 The Selected Load Case does not exist. Make a selection from the list of available load
cases.
6059504 A coefficient of thermal expansion has been entered without a reference temperature for
the material "%A%". The reference temperature must be entered on the Materials form
before this job can be submitted.
6059505 The element properties must be entered for the model before this job can be submitted.
6059506 %A% is not supported for this analysis preference. The load/boundary condition
%A%" must be changed before this job can be submitted.
1992 PCL Reference Manual
Introduction
6059507 Element variable load/boundary conditions are not supported for this analysis
preference. The load/boundary condition "%A%" must be changed before this job can
be submitted.
6059508 The temperature state variable cannot be entered at the nodes for this analysis
preference. The load/boundary condition named "%A%" must be changed before this
job can be submitted.
6059509 The results file name must be enter on the Select Results File form before this job can
be submitted.
6059510 The model does not contain any elements. The object on the Analysis form must be set
to Both before this job can be submitted.
6059511 The model does not contain any nodes. The object on the Analysis form must be set to
Both before this job can be submitted.
6059512 A temperature dependent property has been entered for the material "%A%" without a
reference temperature. The reference temperature must be entered on the Materials
form before this job can be submitted.
6059513 The temperature state variable is defined in the load case, but a reference temperature
was not entered for the material "%A%". The reference temperature must be entered
on the Materials form before this job can be submitted.
6059514 The element uniform heat source is not supported for this analysis preference. The
load/boundary condition named "%A%" must be changed before this job can be
submitted.
6059515 The MarcSubmit script could not be found.
6059516 The pat3mar translator executable could not be found.
6059517 The application region for the load/boundary condition named "%A%" is empty. Do
you wish to ignore load/boundary condition and continue?
6059518 The application region for the element property set named "%A%" is empty. Do you
wish to ignore this element property set and continue?
6059519 Both Nodal and Elemental temperature loads are defined for load case "%A%".
MSC.Marc does not allow this combination. Please use either Nodal or Elemental
temperatures only.
6060000
Patran CFD
6060001 Invalid Geometry Type "%A%" specified. Valid Geometry Types are "Linear" and
"Quadratic".
6060002 Invalid Domain Type "%A%" specified. Valid Domain Types are "3D", "2D", and
"Axisymmetric".
6060003 Unable to open the database "%A%".
6060004 Unable to read load case "%A%" from the database.
6060005 Unable to initialize a hash table for %I% entities.
Chapter 11: Status Messages 1993
Introduction
6060006
Unable to open the Patran CFD grid file "%A%".
6060007 Unable to open the message file "%A%".
6060008
Unable to write the following record to the Patran CFD grid file: "%A%".
6060009 Database error in routine "%A%". Return status = %I%.
6060010 There are no nodes in the model.
6060011 There are no elements in the model.
6060012 There are no Load/Boundary Conditions in load case "%A%".
6060013 All elements in the model must be of type "%A%".
6060014 Unable to acquire %I% words of virtual memory.
6060015 Unable to acquire an array of %I% character strings in virtual memory with each string
having %I% characters.
6060016
Unable to open the Patran CFD solution parameters file "%A%".
6060017
Unable to write the following record to the Patran CFD solution parameters file:
"%A%".
6060018
Patran CFD failed. Please see %A%.msg for more information.
6060019
A loadcase must be selected in the Select Loadcase form before Patran CFD can be
invoked.
6060020
Executing Patran CFD to write the model data to %A%.p3cfd.grf
6060021
Executing Patran CFD.
6060022 Writing solution parameters to %A% ...
6060023 Do you wish to overwrite "%A%"? Select "YesForAll" to overwrite all subsequent
changes, "Yes" to overwrite selectively, or "No" to not overwrite.
6060024 Calculation of Gas Constant for %A% failed. Please check values of [Cp] and [Gamma]
in material property set.
6060025 The Working Fluid, %A%, in the selected ".slp" file does not exist in the database. If
you wish to use this fluid in the analysis, please use the "Materials" application to create
it.
6060026 "%A%" properties are created. Please verify the data prior to performing any
calculation.
6060027 Creation of [%A] properties failed. Please check your data.
6060028 The "%A%" was successfully read. Please verify the data prior to performing any
calculation.
1994 PCL Reference Manual
Introduction
6060029 Error occurred while reading "%A%". Please check the file.
6060030 All analysis parameters will be overwritten by the parameters read from the database.
Do wish to continue?
6060031 Job "%A%" does not exist and cannot be submitted.
6060032
The Patran CFD solver requires FEM entities to be in the X-Y plane only (within global
tolerance). At least one node with z = %A% was detected. Do you wish to continue?
6061001 The current value of %A% is invalid. It must be a real positive number.
6061002 The current values of %A% are invalid. They must be positive real numbers.
6061003 A Working Fluid has not been selected. Please select one.
6061004 Calculation of dimensionless flow parameter(s) failed. Do you wish to continue?
6061005 WARNING: Units are not check for consistency. The consistency of units is the user's
responsibility.
6061006 The selected Working Fluid, %A%, has no property. Please either select a different
fluid or use the Materials option to enter fluid properties.
6061007 An error, %A%, occurred when attempted to retrieve properties. Solution parameter
file cannot be prepared.
6061008 Data for %A% is either missing or out of range. Please use the Materials option to
check/modify the data.
6061009
There is no element for model definition. Patran CFD cannot be invoked.
6061010 Wrong type of element is targeted. Only QUAD4, QUAD9, HEX8, or HEX27 are the
allowable element types.
6061011 Mixed element types are not allowed. The element type must be QUAD4, QUAD9,
HEX8, or HEX27, only.
6061012 The current value of %A% is invalid. It must be a number between 0.00 to 1.00.
6061013 The current value of %A% is invalid. It must be a number between 0.00 to 10.00.
6061014 The current value of %A% is invalid. It must be a number between 0.00 to 100.00.
6061015 The current value of %A% is invalid. It must be a number between 0.38 to 0.44.
6061016 The current value of %A% is invalid. It must be a number between 40.0 to 90.0.
6061017 The current value of %A% is invalid. It must be a number between 2.80 to 4.40.
6061018 The current value of Adaptation Frequency is invalid. It must be a positive number.
6061019
Patran CFD cannot be invoked since %A%.slp was not completed. The operation was
aborted.
Chapter 11: Status Messages 1995
Introduction
6061020
Running Patran CFD on Sun Microsystem requires you to set the DEVICE setting to
XT (i.e. setenv D3DEVICE XT). If this has not been done, it needs to be done now
before execution of the Patran CFD solver. Do you wish to continue?
6070001 ALL %A% within a transient or nonlinear static load case must have the same time
variance or nonlinear load history. This rule is violated in load case: %A%. All %A%
in this load case will be assumed to vary according to the first non-zero data field
reference made by a %A% in this load case.
6080001 Unable to proceed with translation. An error occurred closing the jobfile "%A%%A%".
6080002
Unable to proceed with translation. The Patran FEA results file "%A%%A%" does not
exist.
6080003
Unable to proceed with translation. The Patran FEA matrix file "%A%%A%" does not
exist.
6080004 Unable to proceed with translation. The OUTPUT2 file "%A%" does not exist.
6080005 Delete LMS CADA-X job "%A%" (Y/N)?
6080006 Delete LMS CADA-X job %A% and associated job, message, and neutral files (Y/N)?
6080007 Was not able to delete job "%A%"!
6080008 Was not able to delete file "%A%"!
6080009 No results selected! Please select some results first.
6080101 Jobname file specification missing! Must be first argument.
6080102 Messages output from the PDA %A% translator: %A% %A% on %A% at %A%.
6080103 End of LMS CADA-X file translation.
6080104 Total execution time in real seconds: %G%
6080105 Total execution time in CPU seconds: %G%
6080106 Unable to open the specified database, %A%.
6080107 Reading model information from the specified database, %A%.
6080108 Unable to open the CAD*I neutral file %A%.
6080109 The CAD*I neutral file, %A%, has been successfully opened.
6080110
There are no nodes in the specified Patran database.
6080111
Error retrieving node data from specified Patran database.
6080112 Title = %A%
6080113 FATAL ERROR - Singular rotation matrix detected in LMS_OUTCRD.
6080114 Error reading job file. The first line must be ANALYSIS = pat3lms.
6080115 Error reading job file. The translator name is not pat3lms.
1996 PCL Reference Manual
Introduction
6080116 Error reading job file. There must be an ANALYSIS TYPE = parameter.
6080117
Error reading job file. The analysis type is wrong. It must be set to Patran FEA or MSC
Nastran.
6080118 Error reading job file. There must be an OBJECT parameter.
6080119 Error reading job file. The object is wrong. It must be set to Model/Results, Model
Only, Model/Matrices, or All
6080151
There are no elements in the specified Patran database.
6080152
Error retrieving element data from specified Patran database.
6080153 No property regions are defined in the database. No elements or element properties can
be translated.
6080154 *** Warning: Node ID = 0 for %A% grounded springs/dampers set equal to *** the
nonzero node ID.
6080201 Error retrieving eigenvector data from specified results file.
6080202
Unable to open the Patran FEA results file %A%.
6080204 Error reading the .res file in %A%.
6080205 There are no modal results in the .res file.
6080206 There are no nodes in the .res file.
6080207 There are no modes in the .res file.
6080208 *** Warning: The number of nodes in the model does not match the number of nodes
in the eigenvectors, %I%.
6080209 Error reading displacements for mode: %I%.
6080210 Error reading header for mode: %I%.
6080211 Error: The number of nodes in the Database is less than the number of displacement
(per mode) encountered in the results file.
6080212 Warning: The number of nodes in the Database are not equal to the number of
displacement (per mode) in the results file.
6080213 Error opening file %A% for mode: %I%.
6080214 Error reading header in file %A% for mode: %I%.
6080215 Error reading displacements in file %A% for mode: %I%.
6080216 Error closing file %A% for mode: %I%.
6080217 Error reading results from database.
6080218 Warning: The analysis type is set to %A%, yet the results were created by %A%.
6080219 Error: One of the specified results cases is not a mode shape.
6080220 Warning: Translational dofs set to zero for results case %I%.%I%.
Chapter 11: Status Messages 1997
Introduction
6080221 Warning: Rotational dofs set to zero for results case %I%.%I%.
6080222 Warning: There is no global variable "Frequency" associated with result case
%I%.%I%. Frequency will be set to mode number.
6080223 Error: There are no results values associated with results case %I%.%I%.
6080301
Error retrieving matrix data from specified Patran FEA job.
6080302 *** Warning: Element %I% not found in database, yet there is a matrix associated with
it.
6080303 Unable to open the %A% file.
6080304 There are not property values associated with material %A%.
6080305 Error: Unknown or unsupported element with condensation code %I% encountered
while translating matrices.
6080401 Written: %I5% propertiesto the CAD*I neutral file.
6080402 Written: %I5% nodesto the CAD*I neutral file.
6080403 Written: %I5% materials to the CAD*I neutral file.
6080404 Written: %I5% coordinate frames to the CAD*I neutral file.
6080405 Written: %I5% elements to the CAD*I neutral file.
6080406 Written: %I5% eigenvectors for mode %I3% to the CAD*I neutral file.
6080407 Written: %I5% elemental matrices to the CAD*I neutral file.
6080408 Written: %I5% elemental stiffness matrices to the CAD*I neutral file.
6080409 Written: %I5% elemental mass matrices to the CAD*I neutral file.
6080410 Abnormal termination of MSC Nastran matrix translation. See file %A%. Data blocks
must be written to OUTPUT2 file in order: GEOM2, CSTM, GPL, GPDT, KDICT,
KELM, MDICT, MELM.
6080501 (* CAD*I neutral file created by the PDA %A% translator: *) (* %A% *) (*%A% *)
(* on %A% at %A%. *)
7000000 PCL
7000001 Mismatched function argument:
7000002 Missing arguments to function
7000003 Too many arguments to function
7000004 Bad array subscript
7000005 Array too small Arg#,Size:
1998 PCL Reference Manual
Introduction
8000000 CORE
8100001 Disk full error writing block
8100002 Bad arguments to block I/O
8100003 Block I/O File is not open
8100004 Too many block I/O files opened
8100005 System open error on block I/O
8100006 System read error on block I/O
8100007 System write error on block I/O
8100008 System close error on block I/O
8101001 Bad revision format of stream file
8101002 Bad arguments to stream I/O
8101003 Stream I/O File is not open
8101004 Too many stream I/O files opened
8102001 Bad data given to record I/O
8102002 Invalid position given to record I/O
8102003 Bad arguments to record I/O
8102004 Record I/O File is not open
8102005 Too many record I/O files opened
8103001 File Already Exists
8103002 File Not Found
8103003 Maximum File Version Exceeded
8103004 Failed to Generate Unique Filename
8103005 Error copying from file %A%
8103006 Error copying to file %A%
8103007 System error on file deletion
8103008 System error on file rename
Chapter 11: Status Messages 2003
Introduction
XY Status Conditions
This chapter lists all of the status conditions that are used to report the status of and errors from functions
that manipulate xy data.
10000000 MSG_XY
10000001 Are you sure you want to delete %A% ?
10000002 There is not enough disk space to complete the operation.
10000003 A fatal error has occurred in the database. Database is corrupted.
10000004 The specified operation could not be performed due to a database failure.
10000005 The specified XY title name is invalid. Please Input a valid title name that is 32
characters or less and contains no embedded blanks.
Chapter 11: Status Messages 2005
Introduction
10000006 The XY font name typed in is invalid. Please input a valid font name.
10000007 The X and Y location must both be in %. This is a percentage of the XY window
from the top left corner. Please input valid X and Y locations.
10000008 The specified new title name already exists. Please check the listbox of current title
names and re-input your title name.
10000009 The specified text is invalid. Please input a valid text string.
10000010 The color index has returned an invalid value.
10000011 No memory available for current XY operation.
10000012 Internal XY string lookup failure.
10000013 Invalid option given to XY routine.
10000014 The requested dataset is not found in the curve data file
10000100 There is no current title defined.
10000101 The specified title does not exist in the database.
10000102 The specified curve name is invalid.
10000103 The specified curve does not exist in the database.
10000104 A current curve has not been defined.
10000105 The specified curve name already exists. Please check the listbox of current curves
and re-input your curve name.
10000106 The specified starting point is invalid. Please input another starting point in the
databox.
10000107 The specified ending point is invalid. Please input another ending point in the
databox.
10000108 The specified frequency is invalid. Please input another frequency in the databox.
10000109 The specified symbol is invalid. Please choose another symbol from the option
menu.
10000200 The specified fit function is invalid. Please choose another.
10000201 The specified line style is invalid. Please choose another from the option menu.
10000202 The specified curve thickness is invalid. Please choose another from the slider.
10000300 The axis name is invalid.
10000301 The specified axis does not exist in the database.
10000302 A current axis has not been defined.
10000303 The specified thickness for the axis is invalid.
10000304 The specified axis display location is invalid.
10000305 The specified axis display flag is invalid.
10000306 The specified number of values for the axis is invalid.
2006 PCL Reference Manual
Introduction
11001019 The render style of this group is stored in the database as %A% but is displayed as
%A% because the Fringe/Light styles are not supported in non-fullcolor mode (it
was likely set in a previous fullcolor session). Would you like to change the render
style value stored in the database for this (and possibly other) groups?
11001020 The CURRENT GROUP of a viewport will be unposted. Select a new current group
or this viewport's current group will be unposted.MORE INFORMATION:If the
viewport is current, new entities will not be visible because the viewport's current
group is not posted.
11001021 The current group is being unposted. Do you want to make the target group the new
current group?
11001022 Unposting the current group will render newly created entities invisible in the
current viewport. Continue?
11001023 No group members were selected for a Move/Copy operation.
11001024 No entity type was selected for a Move/Copy operation.
11001025 No group name given. Creating default group name %A%.
11001026 The current group has been changed. %A% is the new current group.
11001027 The group %A% is associated with superelement %A%. Group is not deleted.
11001028 A database inconsistency has prevented the fetching of element property region ID's
for the entities in the target group.
11001029 A database inconsistency has prevented the determination of the internal ID for
newly created %A% %I%.
11001030 Unable to add newly created %A% %I% to the region for element property set
%A%.
11001031 A database inconsistency has prevented the fetching of the physical properties
needed to determine if an element property transformation error can occur.
11001032 %A% %I% of the target group is referenced by element property set %A%, which
contains physical properties that may be incorrect on the newly created %A%
because of the directionality of those physical properties. Do you want this element
property set assigned to the %A% created by the group transformation?
11001033 The group %A% is associated with superelement %A%. Update the superelement.
11001034 The group %A% is associated with superelement %A% and must have elements in
it. Group is not modified.
11001035 The Superelement %A% is associated with the Current Group and will be affected
by this operation.
11001036 Cannot reverse material orientation of elements associated with geometry in mirror
transform
11001037 Cannot get K-node %I% for beam
11001038 Unable to add newly created %A% to the region for element property set %A%.
Chapter 11: Status Messages 2013
Introduction
11001039 Lbc %A% references discrete FEM Field %A%. This field was not expanded to the
newly transformed entities. You must do this manually using Fields/Modify.
11001040 Property %A% references discrete FEM Field %A%. This field was not expanded
to the newly transformed entities. You must do this manually using Fields/Modify.
11001041 %A% of the target group is referenced by element property set %A%, which
contains physical properties that may be incorrect on the newly created %A%
because of the directionality of those physical properties. Do you want this element
property set assigned to the %A% created by the group transformation?
11001042 Certain LBC sets and/or Element Properties in the target group reference discrete
FEM Field %A%. An attempt to modify this field to include newly transformed
entities has failed. You will have to update this field manually using Fields/Modify.
11001043 Discrete FEM Fields are referenced by certain LBC sets and/or Element Properties
in the target group. An attempt to modify these fields to include newly transformed
entities has been aborted due to memory allocation problems or inconsistent data.
You will have to update these fields manually using Fields/Modify.
11001044 Element Property or LBC set [%A%] references Discrete Fem Fields. However, at
least one entity from the application region of this set must be a member of the
current group for the referenced fields to be updated. These fields will not be
updated.
11001045 Element Property or LBC set [%A%] references discrete FEM Field [%A%].
However, there are no common entities between this set and field. This field will not
be updated.
11001046 Element Property or LBC set [%A%] references discrete FEM Field [%A%].
However, at least one entity common to both this set and field must be a member of
the current group for this field to be updated. This field will not be updated.
11001047 Memory allocation error during Group Transform.
11001048 LBC [%A%] and [%A%] have conflicting Coordinate System types for Discrete
Fem Field Updates.
11001049 Conflicting LBC Coordinate System types have been detected for Discrete Fem
Field Updates. This may result in some reversed vector directions. To avoid this you
must not reference the same Discrete Fem Field from LBCs with different
Coordinate System types. Do you want to continue and risk these errors ?
11001050 Selected group was found to have member(s) with hard geometry association and
will not be deleted.
11002000 View
11002001 Delete view %A%?
11002002 Deleted view %A%.
11002003 Created view %A%.
11002004 Renamed view %A% to %A%.
2014 PCL Reference Manual
Introduction
11002007 The back clipping plane is infront of front clipping plane. Please make sure that the
back clipping plane value is less than the front clipping plane value and re-apply.
11002008 The observer position must be a positive number greater than the model tolerance.
Please correct the observer position and re-apply.
11002009 The view plane is behind the observer. Please make sure that the view plane distance
is less than the observer position and re-apply.
11003000 Viewports
11003001 No Viewport selected.
11003002 Delete viewport %A%?
11003003 Viewport %A% deleted.
11003005 Group being posted to unposted viewport.
11003006 The CURRENT VIEWPORT will be unposted. Select a new current viewport in
order to see groups posted from the Group Post form.MORE INFORMATION:If a
group is posted from the Group Post form, it will not be visible because it only posts
to the current viewport.
11004000 Viewport Titles
11004001 Delete viewport title %A%?
11004002 Trying to delete an empty string as the viewport title.
11004003 Trying to rename an empty string as the viewport title.
11004004 Trying to modify an empty string as the viewport title.
11004005 Trying to create a viewport title that is an empty string.
11004006 Trying to create a viewport title that already exists.
11005000 Coordinate Frames
11006000 Display Properties
11006001 Delete Display Property %A%?
11006002 Deleting the last remaining Display Property is not allowed.
11007000 Color Configurations
11007001 Delete Color Configuration %A%?
11007002 Deleting the last remaining Color Configuration is not allowed.
11008000 Spectrums
11008001 Delete Spectrum %A%?
11008002 Deleting the last remaining Spectrum is not allowed.
11009000 Ranges
11009001 Delete Range %A%?
11009002 Spreadsheet Error: The From value in row %A% is greater than the From value in
row %A%
Chapter 11: Status Messages 2015
Introduction
11009003 Spreadsheet Error: The To value in row %A% is less than the From value in row
%A%
11009004 Spreadsheet Error: The From value in row %A% is less than the From value in row
%A%
11009005 Spreadsheet Error: The To value in row %A% is greater than the From value in row
%A%
11009006 Spreadsheet Error: The Middle value in row %A% is not between the To and From
values
11009008 Deleting the last remaining Range is not allowed.
11010000 Light Sources
11010001 Delete Light Source %A%?
11011000 Arbitrary Clipping Planes
11011001 Delete Arbitrary Clipping Plane %A%?
12000000 PREF
12001001 The default model file suffix cannot exceed 4 characters.
12001002 The default results file suffix cannot exceed 4 characters.
12001003 The relative geometric tolerance is out of range. It must be greater than 1.E-6 and
less than 1.0.
12001004 The global model tolerance must be positive.
12001005 The string representation of the selectdatabox label for a coordinate frame exceeds
25 characters.
12001006 Error in initializing Preference %I%. Error code = %I%.
12001007 The Display Method in the Graphics Preferences form must be changed to %A% to
see the selected changes.
12001008 The entity mode render style is stored in the database as "%A%" but is displayed as
"%A%" because the Fringe/Light styles are not supported in non-full color mode (it
was likely set in a previous full color session). Would you like to change the render
style value stored in the database?
12001009 The maximum model dimension must be positive.
12001010 No Analysis Code definitions are stored in this database. Many applications, such
as Element Properties, cannot operate without Analysis Code definitions. Do you
which to load Analysis Code definitions now?
2016 PCL Reference Manual
Introduction
12001011 No Analysis Code definitions are stored in the database. The chosen application
cannot run without Analysis Code definitions. Do you which to load Analysis Code
definitions now?
12001012 The PCL function "%A%" does not exist and no external PCL session file called
"%A%" could be found. Refer to Chapter 7 of Part 9 ( PCL and Customization ) of
the Patran User's Manual for help with loading Analysis Code definitions into a
Patran database.
12001013 The PCL library file, %A%, which would typically be associated with the current
analysis preference, %A%, does not exist. Though it is not required, this file is
normally used to store analysis code specific PCL functions. Refer to Chapter 8 of
Part 9 ( PCL and Customization ) of the Patran User's Manual for further details.
12001014 The PCL function, %A%, does not exist. This function is required for the Analysis
Application. Refer to Chapter 8 of Part 9 ( PCL and Customization ) of the Patran
User's Manual for further details.
12002001 The environment preference was not found.
12002002 The environment preference is of the wrong datatype.
12002003 The string buffer is too small for the preference.
12002004 An error occurred creating an environment preference.
13000000 Database
13000001 Requested file is not a valid database
13000002 Unrecoverable database error
13000003 Disk Full
13000004 Duplicate entry exists in table
13000005 Item to be changed or deleted is still referenced
13000006 Referenced item is missing
13000007 An unspecified database error occurred
13000008 Group not found
13000009 Lookup table not found
13000010 Light source not found
13000011 Render not found
Chapter 11: Status Messages 2017
Introduction
13000224 Database file is locked by another process. NFS access is not permitted.
13000225 Found existing NFS marker file for %A%
13000226 Mesh control applied to Hard Geometry parent.
13000228 The parameter has not been defined.
13000229 The configuration has not been defined.
13000230 The configuration parameter has not been defined.
13000231 The parameter is referenced and cannot be deleted.
13000232 The architecture which database %A% was created on is incompatible with the
operating system on which the current process is running. Currently, databases
created on DEC/Alpha or Windows NT are not accessible on the other supported
platforms, and vise-versa.
13000233
The file %A% appears to be a Patran database, release 7.x or older, but cannot be
upgraded because it was created on a system whose architecture is incompatible with
the current system. The upgrade must be done on the originating system, by
opening it with the latest version of Patran on that system. It can then be accessed
13100010 Error attempting to restore database backup. Backup was found and original may be
corrupted.
13100011 Database %A% is not up to date. Converting database from schema version %A%
to %A% started (backup in %A%.bak).
13100012 Database %A% is now up to date.
13100016 Database Port
13100017 Error attempting to locate database porting utility (dbport). Please contact MSC
Software customer support to obtain the database porting utility.
13100018 Database %A% has been ported to the current platform.
13100019 Database %A% originated on a %A% platform. Now porting to a %A% platform
using the database porting utility (dbport).
13100020 Error attempting to port database %A%. Please contact MSC Software customer
support for more information.
13100021 The database selected for opening is in an older format and needs to be updated.
Please select a file name into which the database file will be copied, updated, and
opened.
14000000 ListProcessor
14000001 LpGetHeapSpace: Allocated heap space is exhausted
14000002 LpEval: Unknown evaluation method
14000003 LpSublistType: No sublist filter bits are set on invocation
14000004 LpSublistType: I am being invoked with a NULL list
14000005 LpSublistType: In the list being used, the current sublist has a nonatomic CAR
14000006 LpSublistType: In the list being used, the current geometry sublist is unclassifiable
14000007 LpSublistType: In the list being used, the current finite element sublist is
unclassifiable
14000008 LpSublistType: In the list being used, the current token sublist is unclassifiable
14000009 LpSublistType: In the list being used, the current sublist is unclassifiable
14000010 LpSublistType: In the list being used, the current sublist does not match the sublist
filter
14000011 LpSublistAttributeGet: Attempt to get attribute from NULL list
14000012 LpSublistAttributeGet: Attribute to retrieve is undefined
14000013 LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
Chapter 11: Status Messages 2025
Introduction
14000040 LpEvalGeometryNode: Insufficient attributes are present for evaluation against the
database
14000041 LpEvaluateExpression: Bad Input list - no valid action: Eval, Construct, etc
14000042 LpEvaluateExpression: Bad Input list - invalid eval class Id, Label, Geometry, etc
14000043 LpEvaluateExpression: Input list must have at least three sublists to be evaluatable
14000044 LpEvaluateExpression: Input list has invalid subaction for construct (2PointCurve,
2SurfaceSolid, etc)
14000045 LpEvaluateExpression: Input list has invalid action (Eval, Construct, etc)
14000046 LpListPrint: Attempt to print an atom with left type of NODE_PTR
14000047 LpListPrint: Attempt to print an atom with an undefined left type
14000048 LpListPrint: Node type is undefined
14000049 LpParseExpression: Excess left parenthesis detected
14000050 LpParseExpression: Excess right parenthesis detected
14000051 LpSearchForTagAndAttribute: Tag not found in input list
14000052 LpSearchForTag: Tag not found in input list
14000053 LpSearchForAttribute: Attribute not found in input list
14000054 LpCOERCE: Input list must be an atom
14000055 LpCOERCE: Attempt to coerce a NULL list
14000056 LpCOERCE: Attempt to coerce a NODE_PTR
14000057 LpCOERCE: Current format of input is unknown
14000058 LpCOERCE: Output format is unknown
14000059 LpCOERCE: Unable to coerce the input string into a valid int
14000060 LpCOERCE: Unable to coerce the input string into a valid float
14000061 LpCOERCE: Output area size is too small
14000062 LpCOERCE_TO_ARRAY: Output array size is too small (must be at least 1)
14000063 LpCOERCE_TO_ARRAY: Unknown atom type encountered
14000064 LpCOERCE_TO_ARRAY: NULL atom encountered
14000065 LpCOERCE_TO_ARRAY: Blob exceeds max size for output array
14000066 LpCOERCETO_ARRAY: Unable to coerce the input string into a valid int
14000067 LpCOERCETO_ARRAY: Unable to coerce complex input list (only coerce atoms
and lists of atoms)
14000068 LpCOERCETO_ARRAY: Max size for output array exceeded
14000069 LpConstruct2PointCurve: Input list must have at least 2 sublists to be evaluatable
14000070 LpConstruct2PointCurve: Input list must have no more than 2 sublists to be
evaluatable
Chapter 11: Status Messages 2027
Introduction
14000179 LpEvalIdElment: Insufficient attributes are present for evaluation against the
database
14000180 LpEvalLabel: A sublist needs evaluation, but does not evaluate successfully
14000181 LpEvalLabel: Attempt to evaluate a screen pick for its Label
14000182 LpEvalLabel: Attempt to evaluate a point immediate for its Label
14000183 LpEvalLabel: Attempt to evaluate a vector immediate for its Label
14000184 LpEvalLabel: Attempt to evaluate a vector for its Label
14000186 LpEvalLabel: The geometric type for evaluation is unknown
14000187 LpEvalLabel: The finite element type for evaluation is unknown
14000188 LpEvalLabel: The entity being evaluated is unknown
14000189 LpEvalLabelPoint: Insufficient attributes are present for evaluation against the
database
14000190 LpEvalLabelCurve: Insufficient attributes are present for evaluation against the
database
14000191 LpEvalLabelCurve: Illegal vertex reference
14000192 LpEvalLabelSurface: Insufficient attributes are present for evaluation against the
database
14000193 LpEvalLabelSurface: Illegal edge reference
14000194 LpEvalLabelSolid: Insufficient attributes are present for evaluation against the
database
14000195 LpEvalLabelSolid: Illegal face reference
14000196 LpEvalLabelCoordinateFrame: Insufficient attributes are present for evaluation
against the database
14000197 LpEvalLabelNode: Insufficient attributes are present for evaluation against the
database
14000198 LpEvalLabelElement: Insufficient attributes are present for evaluation against the
database
14000199 LpGeometryText: there isn't enough room to build the output string
14000200 LpKEYWORD_TEXT: Bad arguments specified
14000201 Invalid output string specified for call
14000208 LpSublistAttributeGet: Curve evaluator error
14000209 LpSublistAttributeGet: Unable to coerce curve within tolerance
14000210 LpSublistAttributeGet: Insufficient size in return area for geometry
14000211 LpSublistAttributeGet: Surface evaluator error
14000212 LpSublistAttributeGet: Unable to coerce surface within tolerance
14000213 LpSublistAttributeGet: Unable to coerce geometry: unknown type
2032 PCL Reference Manual
Introduction
14000262 LpEvalIdMPC: Insufficient attributes are present for evaluation against the database
14000263 LpEvalLabelMPC: Insufficient attributes are present for evaluation against the
database
14000264 LpConstructCurveSurfacePoint: Input list must have at least 2 sublists to be
evaluatable
14000265 LpConstructCurveSurfacePoint: Input list must have no more than 2 sublists to be
evaluatable
14000266 LpConstructCurveSurfacePoint: Input list 1 requires evaluation, but is not
evaluatable
14000267 LpConstructCurveSurfacePoint: Input list 2 requires evaluation, but is not
evaluatable
14000268 LpConstructCurveSurfacePoint: Input list 1 is not a Curve type sublist
14000269 LpConstructCurveSurfacePoint: Input list 2 is not a Surface type sublist
14000270 LpConstructCurveSurfacePoint: Input list 1 does not have a GeometryDefinition
attribute
14000271 LpConstructCurveSurfacePoint: Input list 2 does not have a GeometryDefinition
attribute
14000272 LpConstructCurveSurfacePoint: No intersect exists between the curve and surface
selected
14000273 LpConstructPointSurfacePoint: Input list must have at least 2 sublists to be
evaluatable
14000274 LpConstructPointSurfacePoint: Input list must have no more than 2 sublists to be
evaluatable
14000275 LpConstructPointSurfacePoint: Input list 1 requires evaluation, but it not evaluatable
14000276 LpConstructPointSurfacePoint: Input list 2 requires evaluation, but it not evaluatable
14000277 LpConstructPointSurfacePoint: Input list 1 is not a Point type sublist
14000278 LpConstructPointSurfacePoint: Input list 2 is not a Surface type sublist
14000279 LpConstructPointSurfacePoint: Input list 1 does not have a GeometryDefinition
attribute
14000280 LpConstructPointSurfacePoint: Input list 2 does not have a GeometryDefinition
attribute
14000281 LpExpandPclVariables: Virtual memory is full
14000282 LpSublistAttributeGet: The value for the attribute requested is NULL
14000283 LpGeometricTopologyConverter: Internal error: point does not have a label, but is
the highest topological entity in the chain
14000284 LpGeometricTopologyConverter: Virtual memory is exhausted
14000285 LpGeometricTopologyConverter: Internal Vertex/Edge error
Chapter 11: Status Messages 2035
Introduction
14000286 LpGeometricTopologyConverter: Internal error: curve does not have a label, but is
the highest topological entity in the chain
14000287 LpGeometricTopologyConverter: Virtual memory is exhausted
14000288 LpGeometricTopologyConverter: Internal Edge/Face error
14000289 LpGeometricTopologyConverter: Internal error: surface does not have a label, but is
the highest topological entity in the chain
14000290 LpGeometricTopologyConverter: Virtual memory is exhausted
14000291 LpGeometricTopologyConverter: Internal Face/Body error
14000292 LpGeometricTopologyConverter: Internal error: solid does not have a label, but is
the highest topological entity in the chain
14000293 LpEvalGeometryElement: Insufficient attributes are present for evaluation against
the database
14000294 LpEvalGeometryMPC: Insufficient attributes are present for evaluation against the
database
14000295 LpSublistAttributeGet: The CAD native curve can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000296 LpSublistAttributeGet: The CAD native surface can not be accurately approximated
to within an order of magnitude of the present geometric tolerance.
14000297 LpPicklistTopologicallyReduced: Virtual memory is exhausted
14000298 LpPicklistDecoder: Parse error.
14000299 LpPicklistDecoder: Memory is exhausted.
14000300 LpPicklistDecoderWoLkup: Memory is exhausted.
14000302 LpPicklistDecoderWithLookup: Memory is exhausted.
14000303 LpPicklistStringCreator: Output area of caller would be overflowed if output string
would be completed
14000304 LpAtoi: String out of range for integer conversion.
14000305 LpExtendPicklist: Memory Exhausted assembling picklist
14000306 LpPicklistReadOpen: Memory Exhausted preparing picklist input
14000307 LpPicklistMerge: Picklist merge requested with empty merge list
14000308 LpEval: Memory exhausted preparing to evaluate pick
14000309 LpInputString: Parenthesis nesting is too deep
14000310 LpLexical: Unable to identify token scanned
14000311 LpInputString: Input string does not conform to expected syntax
14000312 LpConstruct2SurfaceCurve: Unable to construct surface from supplied curves
14000313 LpConstruct2SurfaceSolid: Unable to construct solid from supplied surfaces
14000314 LpStringToFloat: Bad numeric string or undefined numeric standin
2036 PCL Reference Manual
Introduction
14000370 LpConstruct3PointPlane: Input list must not have more than 3 sublists to be
evaluatable
14000371 LpConstruct3PointPlane: Input list 1 requires evaluation, but is not evaluatable
14000372 LpConstruct3PointPlane: Input list 2 requires evaluation, but is not evaluatable
14000373 LpConstruct3PointPlane: Input list 3 requires evaluation, but is not evaluatable
14000374 LpConstruct3PointPlane: Input list 1 is not a Point type sublist
14000375 LpConstruct3PointPlane: Input list 2 is not a Point type sublist
14000376 LpConstruct3PointPlane: Input list 3 is not a Point type sublist
14000377 LpConstruct3PointPlane: Input list 1 does not have a GeometryDefinition
14000378 LpConstruct3PointPlane: Input list 2 does not have a GeometryDefinition
14000379 LpConstruct3PointPlane: Input list 3 does not have a GeometryDefinition
14000380 LpConstructPlaneVector: Input list must have at least 1 sublist to be evaluable
14000381 LpConstructPlaneVector: Input list must not have more than 1 sublist to be evaluable
14000382 LpConstructPlaneVector: Input list requires evaluation but is not evaluable
14000383 LpConstructPlaneVector: Input list is not a Vector type sublist
14000384 LpConstructPlaneVector: Input list does not have a Geometry Definition
14000385 LpConstructVectorPlane: Input list must have at least 1 sublist to be evaluable
14000386 LpConstructVectorPlane: Input list must not have more than 1 sublist to be evaluable
14000387 LpConstructVectorPlane: Input list requires evaluation but is not evaluable
14000388 LpConstructVectorPlane: Input list is not a Plane type sublist
14000389 LpConstructVectorPlane: Input list does not have a Geometry Definition
14000390 LpEvalPlaneImmediate: Given more than 3 arguments to evaluate
14000391 LpEvalPlaneImmediate: Given less than 3 arguments to evaluate
14000392 LpEvalPlaneImmediate: Given bad arguments to evaluate
14000393 LpEvalId: Attempt to evaluate a plane immediate for its Id
14000394 LpEvalLabel: Attempt to evaluate a plane immediate for its Label
15000080 Automatic graphics updates are turned off. Update graphics manually with the
repaint icon.
15000081 Extracting %I% edges from %I% elements...
15000082 Extracting %I% faces from %I% elements...
15000083 Calculating the free edges...
15000084 Calculating the free faces...
15000085 Unable to initialize the hardware graphics device. Refer to the hardware
configuration section of the Installation and Operations Manual. Switching to the X
window graphics device.
15000086 Unable to initialize the X window graphics device.
15000087 Detected hardware graphics device which is unsupported. Refer to the hardware
configuration section of the Installation and Operations Manual. Switching to the X
window graphics device.
15000088 Hardware graphics devices are not supported running across the network. Refer to
the hardware configuration section of the Installation and Operations Manual.
Switching to the X window graphics device.
15000089 Unable to locate the hardware graphics device fonts. Refer to the hardware
configuration section of the Installation and Operations Manual. Switching to the X
window graphics device.
15000090
The changes you have made will take effect from the next session of Patran.
15000091 You have turned on visible entity picking. Preselection highlighting will be disabled
until visible entity picking is turned off.
15000092 OpenGL not supported on this device.
15000093 The X11 server extension for OpenGL (GLX) is required for OpenGL to run. Use
"xdpyinfo" or "xglinfo" (or "glxinfo" on SGI) to see the X11 server extensions on
the your display device.
15000094 The available hardware graphics driver initialized for use has been set to the %A%
graphics driver.
15000095 Current graphics driver type in use: %A%
15000100 Messages from MPEG encoder:
15000101 MPEG: %A%
15000102 MPEG encoder terminated.
15000103 Reached maximum number of frames specified (%I%). Terminating MPEG
encoding.
15100001 The option [%A%] was not found. Assigning the default value [%A%].
15100002 The option [%A%] was not found. This option is required.
15100003 The option [%A%] was found but is not set. Assigning the default value [%A%].
2042 PCL Reference Manual
Introduction
15100004 The option [%A%] was found but is not set. You must specify a value for this
option.
15100005 The value [%A%] specified for option [%A%] is not valid. The default value
[%A%] will be used.
15100006 The value [%A%] specified for option [%A%] is not valid. There is no default
value. Please correct it.
15100007 Illegal margin value [%A%] specified for [%A%]. This must be a positive real
number. Valid units are "inches", "cm", "mm", "pts" and "picas".
15100008 Illegal number of copies [%A%] requested. Value must be between [1] and [%A%].
The default value [1] will be used.
15100009 The margins [%A%, %A%, %A%, %A%] exceed eighty percent of the page width
or page height [%F.3%, %F.3%].
15100010 Badly formed keyword [%A%].
15100011 The plot's "Destination" was not specified.
15100012 Illegal "Line Weight" [%A%]. It must be at least 0.001 inch (about 1/16 pt) and no
greater than 0.25 inch (18 pts). Valid units are "inch", "cm", "mm", "pt" and "pica".
15100013 Illegal "Text Scale" [%A%]. It must be at least 10%% and no greater than 1000%%.
You may optionally use "%%" or "percent". Also, you can suppress all text by
entering "None". Note that the base font size (e.g., node number) is 10 pts.
15100014 The "Background" and "Lines & Text" are both set to [%A%]. Change one of them
to [%A%].
15100015 The "One per Page" option is invalid when creating an EPS file.
15100016 Illegal "Scale Factor" [%A%]. This must be a positive real number.
15100017 Illegal "GCR" [%A%]. This value must be between 0%% and 100%%. Using the
default setting of [%A%].
15100018 The custom page size, [%A%] = [%A%] and [%A%] = [%A%] is incorrect. Zero
values are not allowed. Please correct it.
15100019 There were no Printers defined in the Printer Configuration File [%A%]. A default
printer will be created.
15100020 The Printer Configuration File [%A%] was not found. Default printers will be
created.
15100021 No Valid Printers were found in the Printer Configuration File [%A%]. A default
printer will be created.
15100022 The Printer [%A%] is repeated. Multiple occurences of Printers are ignored.
15100023 Undefined Driver [%A%] specified for Printer [%A%]. This Printer will be ignored.
15100024 The Option [%A%] specified for Printer [%A%] has been repeated. Multiple
occurences of Printer Options are ignored.
15100025 The Option [%A%] was found before any Printers were defined. It will be ignored.
Chapter 11: Status Messages 2043
Introduction
15100026 Printer [%A%] was not assigned a Driver. This Printer will be ignored.
15100027 Unknown Option [%A%] found for Printer [%A%]. This Option will be ignored.
15100028 Attempting to create Printer [%A%] by cloning Printer [%A%]. But the Printer to
clone doesn't exist. This Printer will be ignored.
15100029 Printer [%A%] is cloned from Printer [%A%], but they have different Drivers.
Cloned printers must have the same Driver. Printer [%A%] will be ignored.
15100030 The Choice [%A%] assigned to Option [%A%] for Printer [%A%] is illegal. The
default [%A%] will be used.
15100031 Attempting to use the [%A%] feature for Option [%A%] on Printer [%A%]. This
feature cannot be used for this Option. The default [%A%] will be assigned instead.
15100032 The Default value [%A%] extracted from Choice [%A%] for Option [%A%] on
Printer [%A%] is illegal. The default [%A%] will be assigned.
15100033 The Value [%A%] extracted from Choice [%A%] for Option [%A%] on Printer
[%A%] is illegal. The default [%A%] will be assigned.
15100101 No Viewports or XY Windows were found.
15100102 Cannot open output file [%A%].
15100103 %A% file [%A%] complete.
15100104 %A% file spooled to device [%A%].
15100105 Spooling script [%A%] not found.
15100106 Error occurred spooling %A% file [%A%] to [%A%].
15100107 %A% file NOT spooled to device [%A%] per user request.
15101004 Hardcopy output completed.
15200001 No nodes were found in the model.
15200002 No elements were found in the model.
15200003 Entity index allocation error.
15300001 FEM entity create error.
15300002 Not implemented.
15300003 No database regions.
15300004 FEM entity allocation error.
15300005 No database materials.
15300006 FEM entity association stub.
15300007 FEM entity build error.
15300008 FEM entity extract error.
15300009 FEM entity boolean error.
15300010 FEM entity null object.
2044 PCL Reference Manual
Introduction
16000000 APP
16000001 Error code %I% occurred in %A%
16000002 Called from %A%
16000101 Unable to process list: "%A%"
16000102 Database error during List Processing: %A%
16000103 Entity %I% in list "%A%" is neither a geometric nor a FEM entity.
16000104 There are no recognizable items in list: "%A%"
16000105 A programming error has caused an invalid PCL symbol to be passed.
16000106 Element vertices and 3D element edges are not supported. The problem was detected
in list "%A%".
16000107 An unmeaningful element attribute, such as a beam face or edge, has been detected
in list: "%A%".
16000108 There are no recognizable entities in list: "%A%"
16000109 The dimensionality d must satisfy: 0<d<4
16000110 Unable to calculate coordinates for "%A%".
16000111 The dimensionality of the entity "%A%" is inconsistent with the desired output.
16000112 The input entity "%A%" is inconsistent with the desired output.
16000113 Unable to process input entity "%A%".
16000114 Multiple coordinate frames are specified in "%A%" where only one is needed.
Chapter 11: Status Messages 2045
Introduction
16000115 Unable to process input entity "%A%". Check the history window for more
diagnostics.
16000201 Database error for item %I%: %A%
16000202 Error opening database %A%
16000301 Blank string encountered.
16000302 "%A%" does not contain enough arguments, looking for %I% arguments.
16000303 "%A%" has too many arguments, looking for %I% arguments.
16000304 "%A%" is not an integer.
16000305 "%A%" is not a real.
16000400 %I% is not a valid list processor type.
16000501 Unable to allocate %I% bytes of virtual memory.
17000000 LM
17001001 LM_INFO
17001002 The List Manager is not initialized.
17001003 Answer to your question is no.
17001004 Severity of the message %I% is unknown.
17001005 LM_LAST_INFO
17002001 LM_WARNING
17002002 Name %A% is too long.
17002003 Type id %I% is not registered.
17002004 The List Manager received an invalid pointer.
17002005 Item size %I% for item id %I% is invalid.
17002006 List Handle %I% is not valid.
17002007 From argument %I% is not valid in function "A".
17002008 Action argument %I% is not valid in function "A".
17002009 Attempted to access item off of list, lh = %I%.
17002010 Operation is not valid on empty list, lh = %I%.
17002011 Id %I% is not in list, lh = %I%.
17002012 Label %I% is not in list, lh = %I%.
17002013 Attempt to access unlabeled item by label %I%.
2046 PCL Reference Manual
Introduction
18000000 IDD
18001001 IDD_INFO
18001002 The ID Dispenser is not initialized.
Chapter 11: Status Messages 2047
Introduction
19000000 MSH
19001001 MSH_INFO
19001002 Boundary loop was split.
19001003 Pinch is recommended.
19001004 Can't make an element, since the interior of the boundary loop is a hole.
2048 PCL Reference Manual
Introduction
19012001 MSH_REMESH_WARNING
19012002 This remeshing feature is not implemented.
19012003 This remeshing feature is not ready.
19012004 MSH_REMESH_LAST_WARNING
19013001 MSH_REMESH_FATAL
19013002 Failed on abort signal from client.
19013003 Input to remeshing is invalid.
19013004 MSH_REMESH_LAST_FATAL
19014001 MSH_REMESH_CRASH
19014002 Unknown fatal failure while remeshing.
19014003 Fatal List Manager error while remeshing.
19014004 Fatal Vector error while remeshing.
19014005 Fatal Matrix error while remeshing.
19014006 Fatal MFE error while remeshing.
19014007 Fatal Topology Engine error while remeshing.
19014008 Fatal Meshing error while remeshing.
19014009 Fatal Cleanup error while remeshing.
19014010 Fatal Smoothing error while remeshing.
19014011 Fatal Standalone Graphics error while remeshing.
19014012 MSH_REMESH_LAST_CRASH
19021001 MSH_FIXMESH_INFO
19021002 Nothing to fixmesh.
19021003 MSH_FIXMESH_LAST_INFO
19022001 MSH_FIXMESH_WARNING
19022002 This fixmesh feature is not implemented.
19022003 This fixmesh feature is not ready.
19022004 MSH_FIXMESH_LAST_WARNING
19023001 MSH_FIXMESH_FATAL
19023002 Failed on abort signal from client.
19023003 Input to fixmesh is invalid.
19023004 MSH_FIXMESH_LAST_FATAL
19024001 MSH_FIXMESH_CRASH
19024002 Unknown fatal failure while fixing mesh.
19024003 Fatal List Manager error while fixing mesh.
Chapter 11: Status Messages 2051
Introduction
20000000 SGM_IGES
20000001 Change this message.(IGES)
21000000 SGM_UG
21000001
Cannot open this database with standard Patran. Quit Patran and use p3.ug.
21010000 Failure occurred in Unigraphics routine %A%.
21010001 Successful execution of Unigraphics routine.
21010002 Unigraphics reports error opening file %A%. Check part file, Path name, Version
number and check run-time environment variables and/or support files.
21010003 Unable to read Unigraphics model %A%.
21010004 Unable to locate Unigraphics model %A%.
21010005 Unigraphics filename error. Filename is %A%.
21010006 Invalid Unigraphics model type %A%.
21010007 A Unigraphics memory allocation error occurred. Unable to allocate memory.
21010008 A Unigraphics solid face error.
21010009 An error occurred while closing the model. Filename = %A%.
2052 PCL Reference Manual
Introduction
21010060 Missing one or more environment variables. The following MUST be set according to
guidelines given in installation notes: OPENWINHOME (SUN4 ONLY),
LD_LIBRARY_PATH(SUN4 ONLY), UGII_ROOT_DIR, UGII_FILE_SYSTEM,
UGII_BASE_DIR, UGII_USERFCN, UGII_UGSOLIDS, UGII_SCHEMA,
UGII_TERMMOD, UGII_06_FILE, UGII_10_FILE, UGII_CAM, UGII_UGCNCPT.
21010061 Unigraphics part file name length exceeds 40 characters. File Access may abort.
Specify a shorter name including entire path.
21010062 Error writing AutoTetMesher transmit file. Should have write permission to current
directory and/or $HOME directory. Change permission and reaccess CAD Model. If a
transmit file exists already, this warning can be ignored.
21010070 Scanning for entities in layer number %I%
21010071 Processing entities in work layer
21010072 Scanning for curve entities in layer number %I%
21010073 Scanning for surface entities in layer number %I%
21010074 Scanning for solid entities in layer number %I%
21010080 Failed to reopen part file: %A%. Enter a part file name with path:
21010081 Unable to process new entities added to the part file since last access. Only the existing
entities will be processed in this session.
21010082 Unable to get solid extents for Unigraphics solid %I%
21010090 Bounding Box for solid %I%: xmin= %G%, ymin= %G%, zmin= %G%, xmax=
%G%, ymax= %G%,zmax= %G%
21010091 Unigraphics Part File Version Number: %A%
21010200 Unigraphics part name has not been entered. Do you really want to cancel file open
operation and shutdown Patran process ?
21010300 No geometry imported according to the filter set.
21010301 Cannot extract Parasolid transmit file from %A%.
21010302 Import failed because cannot find part %A%. Please re-enter a valid Unigraphics part.
21010303
Regeneration failed because Patran cannot reopen the part %A%. This part might have
been moved. Please re-enter the Unigraphics part with its valid path.
21010304 Regeneration failed because Unigraphics cannot suppress the requested features.
21010305 Regeneration failed because Unigraphics cannot unsuppress the requested features.
21010306 Regeneration failed because Unigraphics cannot edit the requested parameter to the
new value.
21010307 Regeneration failed because Unigraphics cannot update the model.
21010308 Cannot open file to store feature information. No features are written out. Please
verify that the working directory has write permission.
2054 PCL Reference Manual
Introduction
21010309 Model regeneration was disallowed because the Unigraphics part %A% is not
synchronized with the current model version and feature state within Patran. To make
this and further updates on the model, would you like to synchronize the Unigraphics
part?
21010310
Cannot connect to the Patran UG server. Please contact your UNIX System
Administrator to check your machine configuration. Unigraphics Access aborted.
21010311
Cannot connect to the Patran UG server. Please be sure that the Portmap Service is
running or contact your NT System Administrator. Unigraphics Access aborted.
21010312 Importing Unigraphics Features will require that the Unigraphics part file be modified
to reflect the changes made in Patran. Therefore a copy of the part is made to %A%
prior to import. Please do not remove or modify this copy in any way, as subsequent
model updates are dependent on the undisturbed copy. This copy will not work with
any other Patran databases.
21010313 This database already contains features. Additional features can only be imported into
a new Patran database.
21010314 Warning, the Unigraphics part, %A%, already exists in the model. You may re-import
%A% and regenerate the model again. PLEASE NOTE that you lose your feature
parameter edits up to this point if you do a re-import. Suppression state will be
preserved, however. Note, also, that the options flags in effect during the initial import
will be used in the re-import of the model. Do you want to re-import the latest version
of the model?
21010315 Errors during the regeneration of the imported Unigraphics model have resulted in the
original model being deleted and fully replaced with the new version. Any meshes and
LBCs on the original model will have been deleted as well. Do you want to continue
the regeneration process (YES to Continue, NO to Abort)?
21010316 At least one component must be selected, otherwise select the Cancel Button.
21010317 There are no attributes in this Unigraphics part to import.
21010318 The Unigraphics part is not an assembly model, therefore, "Preview Occurrences"
import option was not applicable.
21010319 The Unigraphics model was unable to be updated with the feature suppression states
and parameter values in this database. Do you want to clear all feature suppression
states and parameter changes made since the last successful regeneration?
21010320 Reimport of Unigraphics Assemblies is not supported in this release.
21010321
Import of attributes for an assembly model is not supported in this release of Patran.
Chapter 11: Status Messages 2055
Introduction
21010323
Patran does not support the import/reimport/update of a Unigraphics model which
21011001 Parasolid part %A% already loaded. Cannot load the part again.
21011002 Update functionality not available in this version.
21011003 Illegal or reserved file name. Cannot import transmit file using this name.
21011004 Cannot convert %A% to a trimmed surface. The surface has bad topology or geometry.
21011005 Parasolid error detected in evaluation. Please report this fault.
21011006 UG took special actions to convert some UG bodies at import time. These bodies were
excluded from sewing and a Patran group, %A%, is created to hold these bodies. It
might be best to refit these bodies.
21011007
Invalid bodies were generated as a result of UG sewing. A Patran group, %A%, is
created to hold these bodies. As there is no guarantee that entities in this group will
work with any applications, we strongly recommend you first commit/save the Patran
database and then reconstruct these bodies if possible.
21011100 An error has occurred during update. The original model and CAE data has been
deleted and the new version has been imported.
21011101
A change has been detected in the geometry and topology. This will cause Patran to
eliminate or modify meshes or loads on the highlighted entities. Do you want to
continue?
21011102
If the feature update process continues, Patran geometry associated to the UG model
will be deleted. Do you want to continue?
21011103 The geometry selected to edit is part of a Unigraphics or Parasolid model. If the edit
operation continues and later features or feature parameter editing is attempted, the
associated geometry and CAE data will be deleted. Do you want to continue?
21011104 The geometry selected to edit is part of a Unigraphics part %A%. If the edit operation
continues and later feature or parameter editing is attempted, the associated geometry
and CAE data will be deleted. Do you want to continue?
21011105 A geometric modeling operation has occurred that will cause associated geometry and
CAE data to be deleted should the update continue. Do you want to continue with the
update?
21011106 A geometric modeling operation has occurred that will cause associated geometry and
CAE data to be deleted should the update for the Unigraphics part %A% continue. Do
you want to continue with the update?
21011120
Patran detected a difference between the model unit embedded in the transmit file and
the unit as selected in the transmit file import options form. The model unit of %F%,
which you supplied, will override the embedded unit of %F%.
Chapter 11: Status Messages 2057
Introduction
21011121 The Parasolid transmit file does not have an embedded model unit, and the default
import option is set to "no model unit override." Therefore, Patran will use the default
model unit of meters.
21011122 The model is invalid or contains features not supported.
22000000 SF
22000001 Error committing record file %A%
22000002 Error opening file %A%
22000003 Error processing play file
22000004 Non ascii data read from play file
22000005 Error processing record file %A%
22000006 Session file %A% started playing (level %I%)
22000007 Session file stopped playing (level %I%)
22000008 Session file %A% started recording at %A%
22000009 Session file %A% stopped recording at %A%
22000010 Record to file
22000011 Play from file
22000012 Recording file
22000013 Playing file
22000014 Stopped file
22000015 Stop
22000016 Resume
22000017 Error in dynamic memory allocation
22000018 PCL command in session file not properly terminated
22000019 Recorded by: %A% %A%
22000020 Session file nesting limit exceeded
2058 PCL Reference Manual
Introduction
23000000 CLI
23000001 Maximum of 1024 aliases allowed. You must delete existing aliases before add new
ones.
23000002 Error in allocating memory for alias.
23000003 Alias error during parsing of token %A%.
23000004 Alias command cannot be aliased.
23000005 Unbalanced quotes in command. Command aborted.
23000006 Alias for %A% does not exist.
23000007 Alias for %A% added.
23000008 %A% - 1 alias substituted.
23000009 %A% - %I% aliases substituted.
23000010 Alias for %A% = %A%
23000011 Alias for %A% deleted.
the Patran User Manual Volume 1 under PATRAN INPUT CONVENTIONS for more information.
24000000 NOODL
24000001 Attempting to translate NOODL
24000002 NOODL not supported : %A%
24000003 %A% - DATA/LIST directive processed
24000004 NOODL not recognized : %A%
24000005 NOODL requires more data : %A%
24000006 Illegal surface or edge number specified : %A%
24000007 Must specify number of lines : %A%
24000008 Must specify 2 points : %A%
24000009 Missing DATA or LIST number : %A%
24000010 Error in memory allocation : %A%
Chapter 11: Status Messages 2059
Introduction
25000000 NEUTOLD
25000001 Virtual memory allocation error in %A% routine.
25000005 Analysis preference is not set. Only Phase 1 related quantities will be considered for
import.
25000010
25000020 Do you want the Neutral File printed to the terminal as it is being read?
25000030 %A%. Error string is %A% in column %I%. Format is %A%.
25000040 Unexpected end of data in Packet Number %I%. Select: 1) YES to continue processing
the packets read thus far. 2) NO or ABORT to stop:
25000050 File Summary Information is: %A%, %A%. Do you wish to continue?
25000051
Import of neutral file completed. Should this be committed to the Patran database?
25000052 Importing Packet %A% is not currently supported. Select: 1) OK to skip and continue.
2) ABORT to stop:
25000054 Importing Packet %A% is not currently supported. Select: 1) OK to skip and continue.
2) ABORT to stop:
25000056 In routine %A%, item %A% for I = %I% was not found.
25000058 Import of neutral file failed or aborted. Please use the UNDO button if you want to
remove any items which were imported prior to the failure/abort.
25000060 Nonstandard Packet # %I% encountered. Do you wish to skip this packet and continue?
2060 PCL Reference Manual
Introduction
25000320 Error: No associate data values found for Material ID %I%. Do you wish to skip and
continue?
25000330 PATRAN 2.5 HAL, MIX, and SFC materials are being mapped to either anisotropic,
orthotropic, 2D anisotropic, or 2D orthotropic NON-composites, depending on the
nature of the material. They are not treated as composites because the PATRAN 2.5
neutral file contains no composite construction data for HAL, MIX, and SFC materials.
Laminated composites, however, ARE mapped as composites. Select OK to continue.
25000335 PATRAN 2.5 Ply Material ID %I% was not found. Do you wish to create it as isotropic?
(Note that Auto ID offsets cannot be applied in this case):
25000340 Material %A% already exists. Do you wish to modify it?
25000350 Error in %A%: Invalid PATRAN 2.5 Material Type = %I%. Select ABORT.
25000360 A linear elastic constitutive model will be created for non-composite material "%A%".
25000370 Material %A% was %A% on input. It has been found to be %A% and has been loaded
as such.
25000371 Composite material %A% was %A% on input. It has been found to be %A% and has
been loaded as a non-composite %A% material.
25000372 Laminated composite material %A% has been found to be %A% and has been loaded
as a laminated %A% composite material. All of the membrane, bending, and coupling
stiffness matrices ([A], [D], and [B]) have been retained.
25000401 No element type with a configuration code of <%I%> was found for property set
<%A%>. An element type with a configuration code of "0" will be used instead.
25000402 %I% element properties imported for property set <%A%> may not be allowed in the
database. CHECK all properties created for this set.
25000403 %I% element properties were not imported for element property set <%A%>.
25000404 The following %I% element properties for set <%A%> were not imported and are
REQUIRED: %A%%A%%A%%A%%A%%A%%A%%A%
25000406 No element type could be found for element property set <%A%>.
25000407 Error writing orientation data for property set %A%.
25000408 Error writing material orientation data for property set %A%.
25000410 No elements read in neutral file, reference PATRAN 2.5 Property Id "%I%".
25000420 Property region "%A%" already exists. Do you wish to overwrite it? If you do not want
the elements to be added to the existing application region, abort and offset the element
property ids.
25000430 PATRAN 2.5 Material Id %I% found in Element Property packet was either missing or
not read in. Since it is required, it will be created (with Id offset if applicable).
25000440 Is this an axisymmetric model? (This is only used to determine certain element types
and does not effect future analyses.)
2062 PCL Reference Manual
Introduction
25000441 Is this an 2D thermal model? (This is only used to determine certain element types and
does not effect future analyses.)
25000510 Error in NEUTOLD_CRD_FRM. Select ABORT.
25000520 A coordinate frame definition in a Named Component can not be included in a Group
definition.
25000530 In routine %A%, match for Coord Frame %I% was not found.
25000540 Loadset %I% for Lbc Type %A% already exists. Do you wish to overwrite?
25000545 Duplicate lbc found in Packet %I% on Node %I% is being ignored.
25000550 Error in LBC packet number. Packet Number is %I%.
25000555 Error in %A% routine. Parameter %A% has a value of %I%.
25000560 Error in %A%. Value of ETYP = %I%. Value of NBITS = %A%.
25000570 Error in %A%. Matching lbc string not found. Subscript I = %I%.
25000580 Attempt to create lbc on EDGE %I% of a SOLID (Element ID %I% -- a %A%) in Set
ID %I%. This is not supported in the current version. Do you wish to skip and continue?
25000590 Error in LBC_ID_TYP parameter. Value = %A%. Please select ABORT:
25000610 For variable loads, since field functionality is not available in the current version, the
loads will be averaged and applied to the respective nodes. Select: 1) OK to proceed;
or, 2) ABORT to discontinue run:
25001010 Duplicate Nodal Temperature %F.2% found on Node Id %I% within same PATRAN
2.5 Loadset is being skipped.
25001011 Duplicate Nodal Heat Source %F.2% found on Node Id %I% within same PATRAN 2.5
Loadset is being skipped.
25001012 Duplicate Nodal Force <%F.2% %F.2% %F.2%> found on Node Id %I% within same
PATRAN 2.5 Loadset is being skipped.
25001013 Duplicate Nodal Displacement <%F.2% %F.2% %F.2%> found on Node Id %I%
within same PATRAN 2.5 Loadset is being skipped.
25001401 More than One Sub-Mpc exists which is not supported by routine PGMPC.
25001410 Mpc packet is not supported in the current release. Select: OK to ignore and continue.
2) ABORT to terminate processing:
25002110 Named Component name %A% already exists in the database. Therefore, this group is
being named %A%.
25002120 In Named Component %A%, Entity %A% #%I% is missing from the neutral file.
25002130 In Named Component %A%, an "NTYPE" of %I% found is being ignored.
25003010 Error in Geometry Type = %I% at I = %I%.
25003020 %A% %I% referenced in CFEG table was not found.
25004300 Unmatched mesh found on Line (curve) %I%. Associations between nodes and this
curve will be lost.
Chapter 11: Status Messages 2063
Introduction
25004350 Unmatched mesh found on edge %I% of Patch (surface) %I%. Associations between
nodes and this edge will be lost.
25004400 Unmatched mesh found on edge %I% of Hpat (solid) %I%. Associations between nodes
and this edge will be lost.
25004450 Unmatched mesh found.
25004460 %A% %I% was not found in neutral file. This GFEG record is being skipped.
25004470 Mesh exists for %A% %I%.
25005100 Error in %A%. %A% = %I%. %A% = %I%.
25006000
User Function Id's are supported only for the Patran Thermal Preference. Check that the
26000000 LOADS_BCS
26001010 Load/BC Definition "%A%" does not exist.
26001020 There are no Loads/BCs definitions in the database.
26001021 Unable to retrieve analysis preference information from the database.
26002010 Load/BC Name is "blank". Input a Load/BC Name.
26002011 Load/BC Name "%A%" is too long. Input 32 characters or less.
26002020 Load/BC "%A%" already exists. Do you wish to overwrite?
26002030 "%A%" already exists. Modify not permitted.
26002031 %I% Load/BCs Displacement set(s) exist which have different Analysis Coordinate
Systems. This may result in erroneous analysis results.
26002100 Application Region List is "blank".
26002110 The Application Region databox contains some data. Do you wish to add it to the
Application Region List before continuing?
26002120 "%A%" is an invalid select databox type for the selected Load/BC definition.
26002121 "%I%" is an invalid number of application regions for the specified Load/BC definition.
26002122 "%I%" is an invalid application region id for the specified Load/BC definition.
26002123 Only %I%D elements are allowed. Elements of the wrong dimensionality are included
in the following list: "%A%".
26002130 Element faces are not allowed in the Application Region.
26002131 Element edges are not allowed in the Application Region.
26002132 Element vertices are not allowed in the Application Region.
26002133 The Application Region list "%A%" contains invalid entity types.
26002134 The list "%A%" contains FEM or unknown GEOmetric entities. All the entities in the
application region(s) must be GEOmetric.
26002135 The list "%A%" contains GEOmetric or unknown FEM entities. All the entities in the
application region(s) must be FEM.
26002136 "%A%" is an invalid Geometry Filter. Must be "Geometry" or "FEM".
26002137 Both surfaces and surface edges are not allowed. Select one or the other.
2066 PCL Reference Manual
Introduction
26002138 Both elements and element edges are not allowed. Select one or the other.
26002139 Unable to add the SelectDatabox contents to the Application Region Textbox.
26002140 Unable to remove the SelectDatabox contents from the Application Region Textbox.
26002141 The list "%A%" contains invalid entity type(s).
26002142 "%A%" does not exist. Do you wish to continue?
26002143 None of the entities in the following list "%A%" exist.
26002144 The application region for Load/BC Set "%A%" is empty.
26002145 Unable to process the following list "%A%".
26002200 There was no data input for this Load/BC Set.
26002201 "%I%" is an invalid number of input data fields for the specified Load/BC definition.
26002202 "%I%" is an invalid variable id for the specified Load/BC definition.
26002203 Edge Data was ignored for this Load/BC set.
26002204 Top Surface Data was ignored for this Load/BC set.
26002205 No Coordinate Frame chosen. Select one.
26002206 The data for Data Variable %I% on the "Input Data" form will be ignored because the
spatial databox is blank. Do you wish to continue?
26002207 Surface Data was ignored for this Load/BC set.
26002210 Only one coordinate system is allowed. %I% coordinate systems were input.
26002215 Coordinate Frame List %A% is invalid.
26002216 Load/BC set "%A%" is assigned to FEM entities. No further evaluation is required.
26002217 There are no FEM entities associated to geometric entities in Load/BC set "%A%".
26002218 Evaluating Load/BC set "%A%" at associated FEM entities.
26002219 Load/BC set "%A%" evaluated at associated FEM entities.
26002220 Evaluation of Loads/BCs for element edge associativity not supported YET.
26002221 Bottom Surface Data was ignored for this Load/BC set.
26002222 Top and Bottom Surface Data were ignored for this Load/BC set.
26002223 The analysis coordinate system of nodes associated with Load/BC set "%A%" have
been changed to "Coord %I%".
26002224 All the values are null. Check the field(s) and the application region.
26002225 The Vector pointing from master to slave surface must be defined.
26002226 The Reference Node must be defined.
26002227 The Selected Curves are not contiguous or are overlapping or are branching. Reselect
the valid curves.
26002228 The application region is blank.
26002229 The friction coefficient cannot be negative.
Chapter 11: Status Messages 2067
Introduction
26002421 The Curve(s) selected for this region are congruent to the curves selected in the other
region. The curve(s) were not selected.
26002700 Load/BC set "%A%" modified.
26002701 Load/BC set cannot be renamed to "blank".
26002702 New Load/BC Name "%A%" is too long. Input 32 characters or less.
26002703 No existing Load/BC set is selected.
26002704 Load/BC Set "%A%" is not in the current Load Case. Do you want to leave it out?
26002705 Load/BC Set "%A%" added to current Load Case.
26002750 Update attempted on Loads/BCs Sets. Further editing of Loads/BCs or material angle
may be required. No update attempted for LBCs applied directly to elements, when
those elements are split or their parent geometry is reversed.
26003010 There are no Load/BC sets to delete.
26003020 Load/BC Delete not implemented yet !!
26003030 %I% Load/BC set(s) deleted.
26003040 Load/BC Set "%A%" does not exist.
26003050 %I% Load/BC Set(s) do not exist.
26004001 Unable to assign the scalar table to Group "%A%".
26004002 No data of variable name "%A%" exists for or no FEM entities are associated with any
of the Load/BC set(s) in the current load case. Contours must be done on FEM entities.
26004003 Invalid component "%A%" was specified. Valid component strings are "Resultant",
"Component1", "Component2", and "Component3".
26004004 Invalid number of groups %I% specified. The number of groups must be positive.
26004005 Unable to evaluate field %A% at time %G%.
26004006 No marker data of variable name "%A%" exists for any of the Load/BC set(s) in the
current load case.
26004007 No data of variable name "%A%" is associated with any FEM entities.
26005001 The data entered in databox %I% on the "Input Data" form cannot be parsed.
26005002 The data entered in databox %I% on the "Input Data" form is invalid.
26005003 Databox %I% on the "Input Data" form requires a Scalar field.
26005004 Databox %I% on the "Input Data" form requires a Spatial Vector field.
26006001 Database error encountered: %I%. Call PDA Hotline.
26006002 Evaluation of Fields for Element Variable Load/BC sets has not been implemented yet.
26006003 Unable to acquire %I% words of virtual memory.
26006004 Dynamic memory allocation error encountered.
26006005 List processor error encountered while processing the following list "%A%".
Chapter 11: Status Messages 2069
Introduction
28000000 MATERIALS
28000001 Materials
28003001 The material name is "blank". Enter a material name.
28003002 Material "%A%" already exists. Do you wish to overwrite?
28003003 "%A%" is equal to "ZERO". Do you wish to continue?
28003004 "%A%" has a "negative" value. Do you wish to continue?
28003005 "%A%" has an "INVALID" value. Correct to continue.
28003006 "%A%" have "INVALID" values. Correct to continue.
28003007 %A% matrix cannot be calculated. Check the inputs.
28003008 The selected "Failure Theory" for "%A%" is not currently available.
28003009 "%A%" has a "NON-POSITIVE" value. Do you wish to continue?
28003010 "%A%" have "NON-POSITIVE" values. Do you wish to continue?
28003011 The "%A%" properties have NOT been saved. Do you wish to save them before
exiting?
28003012 The list of ply materials is blank.
28003013 The list of ply thicknesses is blank.
28003014 The list of ply orientations is blank.
28003015 Inconsistent material name information was produced by the list processor.
28003016 The length of the ply thickness list does not match the length of the ply material list.
28003017 The length of the ply orientation list does not match the length of the ply material list.
28003018 Material "%A%" is an invalid constituent material.
28003019 The resulting stacking sequence is not truly antisymmetric since the middle ply angle
is neither 0 degrees nor 90 degrees.
28003020 There are no materials defined in the ply material list.
28003021 There is more than one entry in the string: %A%
28003022 A ply thickness of %F% was entered. Ply thicknesses must be positive.
28003023 A combination of 2-D and 3-D materials exists in the ply stack. %I% of the %I% ply
materials %A% 2-D. All ply materials will be treated as 2-D because there is not
enough information to synthesize 3-D properties. The calculation of [A], [B], and [D]
matrices (membrane, coupling, and bending stiffness) is unaffected.
28003024 The calculated material stiffness matrix is singular.
28003025 Unable to process the list of eligible ply materials contained in the list box.
Chapter 11: Status Messages 2071
Introduction
28003055 Material %A% is not orthotropic. If you continue, it will be assumed to be orthotropic
for this construction. Do you wish to continue?
28003056 Material %A% is not isotropic. If you continue, it will be assumed to be isotropic for
this construction. Do you wish to continue?
28003057 The sum of the volume fractions is zero.
28003058 The calculated material stiffness matrix is not positive definite.
28003059 Material %A% is not a Halpin-Tsai composite.
28003060 Unable to show the properties for composite material %A%.
28003061 The value entered in the databox is out of the range of the associated slidebar.
28003062 The correlation coefficient must be less than one by at least the machine tolerance.
28003063 The number of Monte Carlo iterations must be a positive integer.
28003064 The unidirectional material constituent, %A%, is a 2D material. 3D materials are
required input when Short Fiber composite materials are generated using a fiber
orientation variation in two dimensions.
28003065 The theory for the Short Fiber Composite option calls for a unidirectional constituent
that is a Halpin-Tsai material containing either discontinuous fibers or discontinuous
ribbons. The selected constituent material, %A%, does not satisfy this criterion. Do
you wish to continue?
28003066 Performing Monte Carlo integration...
28003067 The standard deviation must exceed zero by at least the machine tolerance.
28003068 Material %A% is not a Short Fiber composite.
28003069 Halpin-Tsai material %A% is a %A% material, but the existing form is used to display
%A% materials.
28003070 Short Fiber material %A% is a %A% material, but the existing form is used to display
%A% materials.
28003071 The standard deviation cannot be negative.
28003072 The fiber (or particulate) material is not positive definite.
28003073 The matrix material is not positive definite.
28003074 The last volume fraction was not entered. On the assumption that the volume fractions
must sum to one, it has been calculated to be %F%.
28003075 Material names cannot be inserted in the middle of other material names.
28003076 Material %A% cannot be overwritten because it is referenced by another material.
Usually this means that it is a constituent for a composite material. In order to
overwrite it, then, it is necessary first to delete that composite material (or materials).
28003077 Unable to overwrite the record for material %A%.
28003078 No name is given for the material to be created.
28003079 More than one name is given for the material to be created.
Chapter 11: Status Messages 2073
Introduction
28003080 The %A% constituent material %A% does not have all of the properties required of
such materials. The first missing property is the %A% %A%.
28003081 The constituent material %A% has no stiffness defined.
28003082 The constituent material %A% is not positive definite.
28003083 The constituent material %A% has an unrecognized directionality code.
28003084 The constituent material %A% has no constitutive models defined.
28003085 Neither the linearly elastic nor the thermal constitutive model is defined for material
%A% so no composite material properties can be generated.
28003086 The constituent material %A% has no defined properties so no composite material
properties can be generated.
28003087 The Material Action must be %A% or %A%.
28003088 Material %A% does not exist.
28003089 %A% is an INVALID material name.
28003090 %A% already exists. Do you wish to overwrite?
28003091 %A% value(s) already exist. Do you wish to overwrite?
28003092 %A% constitutive model already exists. Do you wish to overwrite?
28003093 The current constitutive model is %A%.
28003094 %A% property set does not include a Linear Elastic model. Do you wish to continue?
28003095 %A% has no Constitutive model defined.
28003096 %A% has no Linear Elastic model defined.
28003097 Some, but not all, of the constituent materials have linearly elastic constitutive models
(which are required for synthesizing composite stiffness properties). Zero values will
be assumed for all stiffness properties of all constituent materials lacking linearly
elastic constitutive models. Do you wish to continue?
28003098 Some, but not all, of the constituent materials have thermal constitutive models (which
are required for synthesizing composite thermal properties). Zero values will be
assumed for all thermal properties of all constituent materials lacking thermal
constitutive models. Do you wish to continue?
28003099 The constituent material %A% has no constant properties so no composite material
properties can be generated.
28003100 Some of the materials used to construct composite material %A% have properties
defined with fields. Field evaluation is not yet supported for the Composite Material
Properties form, so constant property values of 0.0 are used for all field-defined
constituent properties in the evaluation of composite properties. This can result in the
display of erroneous values for the affected composite properties, but it does not mean
that the composite material record in the database has been corrupted.
28003101 Material "%A%" not found. Do you wish to continue?
28003102 Material "%A%" not found.
2074 PCL Reference Manual
Introduction
28003304 Material %A% has been successfully modified. However, it has been detected that
this material is being used as a constituent for one or more composite materials.
Proceeding to update the properties for these composites.
28003305 ...MODIFIED Constituent is %A%: UPDATING Composite %A%.
28003306 Although field %A% has been successfully modified, this field is referenced by
material %A% and the attempt to update this material has failed. A manual modify of
this material is required to update its database properties.
28003307 Material Field %A% has been successfully modified. Proceeding to update database
properties for all materials referencing this field.
28003308 ...MODIFIED Field is %A%: UPDATING Material %A%.
28003401 The selected option is not compatible with %A%.
28003402 To construct %A% specific input entry form, at least "one" valid option MUST be
selected.
28003501 Opening '%A%' materials database.
28003502 Materials database '%A%' is not found.
28003503 Materials database '%A%' cannot be opened.
28003504 Materials database '%A%' cannot be read.
28003505 Materials databases directory was not found in your current definition of the
environment variable P3_HOME.
28003506 Not authorized Materials database '%A%'.
28003601 Opening '%A%' Mapping template file.
28003602 Mapping template '%A%' is not found.
28003603 Mapping template '%A%' cannot be opened for read access.
28003604 Mapping template '%A%' cannot be opened for write access.
28003605 Mapping template '%A%' cannot be read.
28003607 Mapping template's column headers '%A%' are not valid for this database. Defaulting
to the first relation's attributes as column headers.
28003608 Mapping template's column headers/mapping attributes '%A%' are not valid for this
database and are ignored.
28003609
Mapping templates directory '%A%' not found in current Patran search path.
28003610 Mapping template data has been modified (mapping attributes, column headers, unit
system or query condition). Save these changes in '%A%' before exiting?
28003611 Mapping template '%A%' saved.
28003612 Mapping template query '%A%' is invalid for this database. Query is ignored.
28003613
No property mappings currently exist. Use the '%A%' button to map Patran properties
to the database attributes.
2076 PCL Reference Manual
Introduction
28004206 Property set '%A%' contains no rows. Select another material or change the current
query condition to select data for this property set.
28004301 Material has been selected and/or modified. Save before exiting?
28004302 The selected row for curve '%A%' contains non-curve point data (scatter points, run
out points,...). Select another row.
28004303 Curve '%A%' contains non-curve point data (scatter points, run out points,...). Field
not created.
28004401 There are no rows in the spreadsheet so none can be deleted.
28004402 No rows have been selected so none can be deleted.
28004403 There are more terms in the text list than there are available rows in the spreadsheet.
Would you like to have additional rows inserted once the available rows are
overwritten?
28004404 The proposed ply material %A% does not exist.
28004405 Unable to extract ply material array because of problems with mapping a virtual array
onto PCL.
28004406 Unable to extract real values because of problems with mapping a virtual array onto
PCL.
28004407 There are no real numbers in the list.
28004408 Laminate layer %I% has no material name specified.
28004409 Laminate layer %I% has no thickness specified.
28004410 Laminate layer %I% has no orientation specified.
28004411 The fiber/ribbon material %A% is isotropic. This is not consistent with the intention
of this Halpin-Tsai material model.
28004412 The length of the ply thickness list exceeds the length of the ply material list. If you
continue, the excess will be ignored. Do you wish to continue?
28004413 The length of the ply orientation list exceeds the length of the ply material list. If you
continue, the excess will be ignored. Do you wish to continue?
28004414 The length of the phase volume fraction list exceeds the length of the phase material
list. If you continue, the excess will be ignored. Do you wish to continue?
28004415 The length of the phase orientation list exceeds 3 times the length of the phase material
list. If you continue, the excess will be ignored. Do you wish to continue?
28004416 Material %A% does not exist.
28004417 Ply material %A% does not exist.
28004418 Phase material %A% does not exist.
28004419 The unidirectional constituent material %A% does not exist.
28004420 The proposed phase material %A% does not exist.
28004421 The %A% material has not been defined.
2078 PCL Reference Manual
Introduction
29000000 ELEM_PROPS
29001001 Unable to allocate the necessary memory.
29001002 Field Id %I% not found.
29002001 No Element Definitions are in the database for analysis code "%A%" and analysis
type "%A%".
29002002 Unable to retrieve analysis preference information from the database.
29002003 Unable to retrieve the element definitions for analysis code "%A" and analysis type
"%A%" from the database.
29002004 Unable to retrieve the element options from the database.
29002005 Property Set Name is "blank".
29002006 Property Set "%A%" Exists. Overwrite?
29002007 The data entered for Property "%A%" cannot be parsed. %A%
29002008 The data entered for Property "%A%" is invalid. %A%
29002009 Property "%A%" requires a Spatial Scalar field. %A%
29002010 Property "%A%" requires a Spatial Vector field. %A%
29002011 A value for Property "%A%" must be entered. %A%
29002012 The data form for Property "%A%" is invalid. %A%
29002013 The data form for Property "%A%" is not recognized by the system. %A%
29002014 The material specified for property "%A%" is invalid. %A%
29002015 The property definition for property "%A%" is invalid. %A%
29002016 The value of property "%A%" is not in the valid range. %A%
29002017 Unable to parse the Application Region list.
29002018 The Application Region list contains entities other than elements and %A%s. Ignore
and continue?
29002019 The elements in the Application Region list with %A% topologies are not valid for
this element type. Ignore and continue?
29002020 Element %I% already has been associated to an element property region. Overwrite
the association?
29002021 The Element Properties must be Entered to continue.
2080 PCL Reference Manual
Introduction
29002022 %A% already has been associated to an element property region. Overwrite the
association?
29002023 Some of the Geometric entities being meshed are in Element Property Region %A%,
which does not support %A% element topologies. Proceed with Meshing?
29002024 Some of the Geometric entities being meshed are in Element Property Region %A%,
which will not support any elements that have %A% topologies. Proceed with
Meshing?
29002025 The material specified for property "%A%" has an invalid Constitutive model
activated. %A%
29002026 The material specified for property "%A%" has an invalid Directionality for this
element type. %A%
29002027 The elements associated to the geometry in the Application Region list with %A%
topologies are invalid for this element type. Ignore and continue?
29002028 Property Set "%A%" created.
29002029 Unable to retrieve the property set definition from the database.
29002030 Unable to retrieve the property definition from the database.
29002031 Maximum number of allowable properties exceeded. The first %I% will be used.
29002032 Unable to retrieve the element property sets from the database.
29002033 An error occurred while processing Property "%A%". %A%
29002034 Material "%A%" created with no properties.
29002035 "%A% %A%" does not exist. Continue?
29002036 The Application Region select databox contains some data. Do you wish to add it to
the Application Region List before continuing?
29002037 The material specified for property "%A%" must be a laminate. %A%
29002038 Beam Section "%A%" not found. %A%
29002039 Beam Section "%A%" is an invalid Type for this Option.
29002040 Beam Section "%A%" already exists. Do you wish to overwrite?
29002041 Database Error %I% Creating Beam Section "%A%".
29002042 Beam Section Name is "blank". Input a Beam Section Name.
29002043 Beam Section Type "%A%" Invalid.
29002044 Wrong number of Beam Section Dimensions Input.
29002045 Invalid Field "%A%". Must be Spatial Parametric with C1 as only variable.
29002046 Invalid Beam Section Dimension "%A%".
29002047 Beam Section "%A%" created.
29002048 Entity type "%A%" invalid. Must be 1D Element or Curve.
29002049 Element "%I%" node not found.
Chapter 11: Status Messages 2081
Introduction
29002076 The "Associate Beam Section" toggle was off. Turning the toggle on will recompute
and overwrite the current databox properties. Do you want to continue and turn the
"Associate Beam Section" toggle on ?
29002077 The "Associate Beam Section" toggle is off. Your value of %G% for "%A%" differs
from the Beam evaluator by more than 1%%. Your value will be used for analysis,
but the beam section will display unchanged. Do you want to ignore this difference ?
29002078 Due to differences between your input and the Beam evaluator, you chose to abort.
29002079 The "Associate Beam Section" toggle is off. The values for "%A%" differ from the
Beam evaluator. Your value will be used for analysis, but the beam section will
display unchanged. Do you want to ignore this difference ?
29002080 Maximum number of boundary loops exceeded. You can currently have no more than
8 loops on the selected surface.
29002081 The boundary is invalid for a section due to overlapping points. If the boundary is
generated by selecting a surface, please recreate a trimmed surface and try again.
29002082 The report file specified, "%A%", does not contain the keywords "Boundary Loops"
preceding a list of XY pairs.
29002083 Property "%A%" fields must be Scalar, Non-Spatial, Tabular functions of frequency
only. %A%
29002084 Property "%A%" fields must be Scalar, Non-Spatial, Tabular functions of
displacement only. %A%
29002085 Property "%A%" must be a Scalar, Non-Spatial, Tabular function of frequency only.
%A%
29002086 Property "%A%" must be a Scalar, Non-Spatial, Tabular function of displacement
only. %A%
29002087 Unable to retrieve the field definition from the database.
29002088 Property "%A%" of Element Property Set "%A%" requires a Spatial Scalar field.
29002089 Property "%A%" of Element Property Set "%A%" requires a Spatial Vector field.
29003001 Property Set "%A%" cannot be deleted.
29003002 The property set already exists.
29003003 %I% Property Sets deleted.
29003004 Database Error %I% Deleting Beam Section "%A%".
29003005 %I% Beam Section(s) deleted.
29003006 No Beam Sections specified for deletion.
29003007 Section "%A%" associated with Element Property data and is not deleted.
29003008 Property Set "%A%" is associated with contact lbcs and cannot be deleted or
modified.
29004001 No Groups Selected.
Chapter 11: Status Messages 2083
Introduction
29004002 Number of Groups does not match dimension of the given array.
29004003 Group "%A%" was not found.
29004004 No property has been selected to Show.
29004005 The display method "%A%" is not recognized.
29004006 Property "%A%" could not be retrieved from the database.
29004007 The display method "%A%" cannot be applied to property "%A%".
29004008 No elements were found that referenced the specified property.
29004009 Invalid Field "%A%". Base Geometric Entity Type Must be Curve or Surface Edge.
29004010 Physical Property %A% in Element Property set %A% cannot be evaluated because
it is represented over at least part of the display region as a Non-Spatial Field.
29005001 An unknown Element Topology has been referenced.
29005002 No Shape function is available for this element topology
29006001 Property Set "%A%" does not exist and cannot be modified or deleted.
29006002 No existing Property Set has been selected to modify.
29006003 The Property Set Name "%A%" is invalid.
29006004 Property Set "%A%" modified.
29006005 Beam Section "%A%" modified.
29006006 No existing Beam Section has been selected to modify.
29006007 Database Error %I% Modifying Beam Section "%A%".
29007001 No element type of dimension %I% was found for property set "%A%".
29007002 Unable to Convert property set "%A%".
29007003 A matching element type was found for property set "%A%".
29007004 A matching element type with some differences was found for property set "%A%".
29007005 No matching element type was found for property set "%A%". The default %I%
dimension element was substituted.
29007006 No matching element type was found for property set "%A%".
30000000 FIELDS
30001001 Field Name is "blank". Enter a Field Name.
30001002 No Field Name selected.
30001003 Field "%A%" already exists. Overwrite?
30001004 Fields Function is "blank". This is assumed to be correct.
30001005 Fields Table is incomplete.
30001006 No Active Independent Variables chosen. Select at least 1.
30001007 Coordinate Frame "%A%" does not exist.
30001008 Table Input Data box contains invalid data.
30001009 Linear Parametric Table data box "%A%" contains invalid data.
30001010 No Cells selected. Select at least 1.
30001011 Independent Variable data for "%A%" must in ascending order.
30001012 Parametric Independent Variable data for "%A%" must be between 0 and 1.
30001013 The Object "%A%" is Invalid. Must be "Spatial", "Material", or "Non-Spatial".
30001014 The Method "%A%" is Invalid. Must be "Table" or "Function".
30001015 The Type "%A%" is Invalid. Must be "Scalar" or "Vector".
30001016 The Coordinate System Type "%A%" is Invalid. Must be "Real or Parametric".
30001017 The Material or Non-Spatial Coordinate System Type "%A%" is Invalid. Must be
"Real".
30001018 The Geometric Entity "%A%" is Invalid. Must be an existing Surface or Solid.
30001019 The Geometric Entity "%A%" is Invalid. Must be an existing Solid.
30001020 The Geometric Entity "%A%" is Invalid. Must be an existing Solid???.
30001021 The Geometric Entity "%A%" is Invalid. Must be an existing entity.
30001022 Given the Independent Variables specified, the Geometric Entity "%A%" is Invalid.
Must be an existing Surface or Solid.
30001023 Given the Independent Variables specified, the Geometric Entity "%A%" is Invalid.
Must be an existing Solid.
30001024 The Geometric Entity "%A%" is Invalid. Select an existing Curve before displaying the
Input Data form.
30001025 The Geometric Entity "%A%" is Invalid. Select an existing Surface before displaying
the Input Data form.
30001026 The Geometric Entity "%A%" is Invalid. Select an existing Solid before displaying the
Input Data form.
30001027 Incorrect number of Valid Independent Variables Defined. Match the number of
variables given (%I%) with the given strings.
Chapter 11: Status Messages 2085
Introduction
30001053 The Geometric Entity Box is Blank. Please select a geometric entity.
30001054 The databox for argument "%I%" is blank. Please fill in to continue.
30001055 The selected function has zero arguments.
30001056 The selected function cannot be found within PCL.
30001057 The selected function is a "Built In" function.
30001058 Error getting the current Analysis Code Name from the Database.
30001059 Error getting the Field "%A%" from the database.
30001060 The "Function Expression" box in the Input Data form is blank. Please create a
Function Expression.
30001061 Field "%A%" is disassociated with geometry entity and unusable unless a new
geometry entity is provided.
30001062 No more than 3 Active Independent Variables may be chosen.
30001063 The text string has invalid syntax. The equation must be enclosed in parentheses.
30001064 The text string has invalid syntax. The leading part of the string must be "equation(".
30001101 Field "%A%" does not exist.
30001102 No Field is selected for deletion.
30001103 Field "%A%" deleted.
30001104 Field "%A%" cannot be deleted because it is attached to a Load/BC, Element Property,
or Material.
30001201 Field "%A%" already exists. Modify not permitted.
30001202 Field "%A%" does not exist.
30001203 New Field Name "%A%" is invalid.
30001204 Field "%A%" modified.
30001205 Field "%A%" cannot be modified because it is attached to a Load/BC, Element
Property, or Material.
30001206 A continuous FEM field cannot be changed to a discrete FEM field.
30001401 Unable to allocate enough memory to evaluate the field.
30001402 No Evaluation method is defined for this field type.
30001403 The PCL expression references an invalid independent variable.
30001404 Error occurred when evaluating the PCL expression.
30001405 PCL expression is blank. Use `t or `f as the variable.
30001406 Invalid PCL expression.
30001407 Number of points must be greater than 0.
30001408 Too many points specified. Lower the number of points or add rows using the
"Options" form.
Chapter 11: Status Messages 2087
Introduction
30001439 %A% set <%A%> references nodal Dfem Field <%A%>. However, primary node
%I% %A% & secondary node %I% %A% of the %A% Application Region(s). These
nodes both exist in the Dfem Field, and will be equivalenced in accordance with
specified merge rule. Is it acceptable to continue?
30001440 %A% set <%A%> references nodal Dfem Field <%A%>. However, primary node
%I% %A% & secondary node %I% %A% of the %A% Application Region(s). Only
the secondary node exists in the Dfem Field, and will be equivalenced in accordance
with specified merge rule. If you continue, the primary node will become part of the
Dfem Field. Is it acceptable to continue?
30001441 Field "%A%" contains no data. This usually results from deleting the elements used to
create the field.
30001442 The spatial field %A% could not be evaluated because it contains non-spatial
independent variables.
30001443 The parametric field %A% could not be evaluated because it contains non-parametric
independent variables.
30001501 No Active Independent Variable chosen.
30001502 The Minimum Value %F% for the Independent Variable is Out of Range.
30001503 The Minimum Value %F% for the First Fixed Variable is Out of Range.
30001504 The Minimum Value %F% for the Second Fixed Variable is Out of Range.
30001505 The Maximum Value %F% for the Independent Variable is Out of Range.
30001506 The Maximum Value %F% for the First Fixed Variable is Out of Range.
30001507 The Maximum Value %F% for the Second Fixed Variable is Out of Range.
30001508 Can't Use Existing Points with a Function.
30001509 Invalid Vector Component %I% Specified.
30001510 Invalid Data Used to Get Field Points. Check for Valid Functions, Dimensions,
Number of Variables. No Curves created.
30001511 Too many existing points specified. Only the first %I% specified will be used.
30001512 There are more points between the specified minimum and maximum. Only the first
%I% will be used.
30001513 No Independent Variable is associated with this field.
30001514 Illegal Independent Variable "%A%" found. Variable must match specified values.
30001515 Field "%A%" is disassociated with geometry entity and cannot be shown.
30001516 The Fields:Show facility does not support general fields at this time.
30001517 Number of points must be greater than 0.
30001601 No Scalar table has been associated to group "%A%". Plot contours on the mesh to
create a Scalar table.
Chapter 11: Status Messages 2089
Introduction
30001602 No Vector table has been associated to group "%A%". Plot vector markers on the mesh
to create a Vector table.
30001700 Field "%A%" is a Finite Element Field and cannot be processed by the Fields
application.
30001701 Group "%A%" does not exist.
30001702 "%A%" is not a valid FEM entity.
30001703 "%A%" is not a valid Node.
30001704 "%A%" is not a valid Element.
30001705 Can't assign more than one entity.
30001706 "%A%" is an invalid Scalar value.
30001707 "%A%" is an invalid Vector value.
30001708 Value cannot be a Field.
30001709 Scalar value cannot be NULL.
30001710 No rows selected. Select the ones to be deleted.
30001711 Can't delete specified number of rows. Change the value in the insert/delete databox.
30001712 The Entity Type "%A%" is Invalid. Must be "Node" or "Element".
30001713 Number of Entities cannot be negative.
30001714 "%A%" does not exist. Please choose from the existing Elements.
30001715 "%A%" does not exist. Please choose from the existing Nodes.
30001716 The Face of "%A%" does not exist. Please choose from the existing entities.
30001717 The Edge of "%A%" does not exist. Please choose from the existing entities.
30001718 The Vertex of "%A%" does not exist. Please choose from the existing entities.
30001719 No Cells selected. Select at least 1.
30001720 "%I%" is not a valid Interpolation Direction. Use 1 for x, 2 for y, 3 for z, or 0 for
axisymmetry.
30001721 A Node is defined more than once.
30001722 The Entity Type selected on the Fields form does not match the entity value: "%A%".
Delete this value or change the Entity Type.
30001723 Group Name is not selected. Select a Group Name.
30001724 Group "%A%" not found. Select an existing Group Name.
30001725 Group cannot be changed in Modify. Create a new field if needed.
30001726 The group that this field was created with no longer exists. The field should be deleted
since it is longer valid.
30001727 Scalar/Vector table no longer associated with the group this field was created with.
2090 PCL Reference Manual
Introduction
30001728 Multiple vectors are displayed on one or more nodes. Re-display with only one vector
per node.
30001729 More than one Coordinate Frame defined. Select only one per Field.
30001730 More than one Geometric Entity defined. Select only one per Field.
30001731 Each dimension of the table must be at least 1.
30001732 The spreadsheet layer dimension must be least 2 in this 3d case. If only 1 layer is
desired, use the 2d case.
30001733 Independent variable "%A%" of cylindrical or spherical coordinate system must be
between -PI and PI.
30001800 Field "%A%" is a Load/BC Field and cannot be processed by the Fields application.
30001900 Database error encountered while extracting list of field names.
30002000 Unable to create a valid entity list from the entities of field %A%. No entities will be
loaded into the application region of the parent application.
30002001 No cells with Vector data has been selected. Select at least 1.
30002002 The entity type (node or element) of existing Discrete FEM Field %A% conflicts with
the entity type of the parent application. Existing field data WILL NOT be retrieved.
30002003 The field type (scalar or vector) of existing Discrete FEM Field %A% conflicts with
the data
31000000 EM
31000001 Group definition hasn't been started
31000002 A group definition has already been started
31000003 The group is full
31000004 Initialization of group data structures failed
31000005 The specified group does not exist
31000006 Event definition hasn't been started
31000007 Event has not been routed
31000008 No memory available
31000009 The specified event doesn't have an output function
31000010 The event type does not exist
31000011 The item does not exist for the specified type
31000012 The specified event is unknown
Chapter 11: Status Messages 2091
Introduction
32000000 Security
32000006 The license(s) for %A% will expire in %I% days. License File: "%A%". Please
request your systems administrator to review the installation procedures for MSC
Software products on your system and/or contact your Patran Support Representative
for further assistance.
32000009 %A% is unable to establish communication with the FLEXlm server or could not find
a valid license in the file "%A%". Please request your systems administrator to review
the installation procedures for MSC Software products on your system and/or contact
your Patran Support Representative for further assistance.
32000010 An unknown FLEXlm error was encountered. %A%, License File: "%A%" Please
request your systems administrator to review the installation procedures for MSC
Software products on your system and/or contact your Patran Support Representative
for further assistance.
32000011 Configuration parameters passed from %A% to FLEXlm were invalid. The program
will not proceed until this is resolved. License File: "%A%" Please request your
systems administrator to review the installation procedures for MSC Software
products on your system and/or contact your Patran Support Representative for
further assistance.
32000014 The version %A% license(s) for %A% have expired. License File: "%A%". Please
request your systems administrator to review the installation procedures for MSC
Software products on your system and/or contact your Patran Support Representative
for further assistance.
2092 PCL Reference Manual
Introduction
32000018 FLEXlm has denied access to %A% because of restrictions found in your local
options file. License File: "%A%". Please request your systems administrator to
review the installation procedures for MSC Software products on your system and/or
contact your Patran Support Representative for further assistance.
32000019 You have requested to run %A% on a %A% %A%. Unfortunately, this requires %I%
version %A% license(s). License File: "%A%". Since there are insufficient licenses
installed to satisfy this request, Please request your systems administrator to review
the installation procedures for MSC Software products on your system and/or contact
your Patran Support Representative for further assistance.
32000020 Your application has lost contact with the FLEXlm license server. An attempt will be
made to reacquire license(s). License File: "%A%"
32000021 %A% is an unknown application within MSC Software's product configuration.
Please request your systems administrator to review the installation procedures for
MSC Software products on your system and/or contact your Patran Support
Representative for further assistance.
32000022 FLEXlm initialization complete. Acquiring license(s)... License File: %A%
32000023 %A% %A% has obtained %A% %A% license(s) from FLEXlm per a request to
execute on a %A% %A% system at %A%.
32000024 %A% %A% has renewed %A% license(s) from FLEXlm at %A%.
32000025 %A% %A% has released %A% license(s) to FLEXlm at %A%.
32000026 You have requested to run %A% on a %A% %A%. There are no version %A%
licenses installed to satisfy this request. License File: "%A%" Please request your
systems administrator to review the installation procedures for MSC Software
products on your system and/or contact your Patran Support Representative for
further assistance.
32000027 FLEXlm found an expired NODELOCKED version %A% license for %A% in the
file %A% on your system. Attempting to allocate a CONCURRENT license from the
network license database...
32000028 %A% %A% has reacquired it's license(s) from FLEXlm per a request to execute on a
%A% %A% at %A%. License File: %A%
32000029 Your application has lost contact with the FLEXlm license server and did not
successfully release your allocated license(s). License File: "%A%". Please request
your systems administrator to review the installation procedures for MSC Software
products on your system and/or contact your Patran Support Representative for
further assistance.
32000030 Request to run %A% is in FLEXlm input queue on %A%. License File: "%A%".
Chapter 11: Status Messages 2093
Introduction
32000031 You have requested to run %A% on a %A% %A%. Currently, there are insufficient
version %A% licenses available to satisfy your request. License File: "%A%". Your
request will be placed in the FLEXlm input queue at %A%. To determine the current
allocation of licenses, on your network, please use the FLEXlm utility "lmstat".
Currently known users are: %A% Click OK to wait or "STOP" (the hand) to exit the
queue.
32000032 Welcome to %A%! You are using a special demonstration version of this software
product. This software has not been certified for production use and will not be
supported by MSC Software Corporation. The use of this software is strictly intended
for promotional purposes only. Any other use of this software is strictly prohibited.
A license agreement (contract) for the use of this demonstration software from MSC
Software Corporation. contains additional terms and conditions. The use of this
version of software constitutes acceptance of this license agreement. License File:
"%A%".
32000033 %A% is a group license member which would cause the group table limit of %I% to
be exceeded. License File: "%A%". Please request your systems administrator to
review the installation procedures for MSC Software products on your system and/or
contact your Patran Support Representative for further assistance.
32000034 The number of options for %A% exceeds the maximum allowed, %I%. License File:
"%A%". Please request your systems administrator to review the installation
procedures for MSC Software products on your system and/or contact your Patran
Support Representative for further assistance.
32000035 An option specified for %A% is unknown or misspelled. License File: "%A%". Please
request your systems administrator to review the installation procedures for MSC
Software products on your system and/or contact your Patran Support Representative
for further assistance.
32000036 You have requested the use of %A%. This option has not been enabled at your site.
License File: "%A%". Please request your systems administrator to review the
installation procedures for MSC Software products on your system and/or contact
your Patran Support Representative for further assistance.
32000037 The base license value for %A% is illegal or out of range. License File: "%A%".
Please request your systems administrator to review the installation procedures for
MSC Software products on your system and/or contact your Patran Support
Representative for further assistance.
32000038 A group membership option for %A% was specified but is NULL. License File:
"%A%". Please request your systems administrator to review the installation
procedures for MSC Software products on your system and/or contact your Patran
Support Representative for further assistance.
2094 PCL Reference Manual
Introduction
32000039 The group license value for %A% is illegal or out of range. License File: "%A%".
Please request your systems administrator to review the installation procedures for
MSC Software products on your system and/or contact your Patran Support
Representative for further assistance.
32000040 More than one group membership was specified for %A%. License File: "%A%".
Please request your systems administrator to review the installation procedures for
MSC Software products on your system and/or contact your Patran Support
Representative for further assistance.
32000041 Your request to run %A% has been dequeued.
32000042 Your license to run %A% has been granted! %A%
32000043 Your license to run %A% cannot be granted at this time. There are no licenses
currently available and %A% license upgrades cannot be queued. Please try again
later. License File: "%A%".
32000044 The maximum %A% option value for %A% is illegal or out of range. License File:
"%A%". Please request your systems administrator to review the installation
procedures for MSC Software products on your system and/or contact your Patran
Support Representative for further assistance.
32000046 Click "STOP" (the hand) at any time to exit the queue.
32000047 %A%
32000048 Your application has lost contact with the FLEXlm license server. Atempts to
reacquire license(s) have failed. The application will now exit. License File: "%A%"
Please request your systems administrator to review the installation procedures for
MSC Software products on your system and/or contact your Patran Support
Representative for further assistance.
32000049 %A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%
%A%%A%%A%%A%%A%%A%%A%
%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%
%A%%A%%A%%A%%A%%A%%A%
%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%
%A%%A%%A%%A%%A%%A%%A%
%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%
%A%%A%%A%%A%%A%%A%%A%
%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%%A%
%A%%A%%A%%A%%A%%A%%A% %A%%A%%A%%A%%A%
32999999
A Patran function that has not yet been completely coded has been called.
Chapter 11: Status Messages 2095
Introduction
33000000 MFE
33001001 MFE_INFO
33001002 MFE is not initialized.
33001003 Answer to your question is no.
33001004 Severity of the message %I% is unknown.
33001005 MFE_LAST_INFO
33002001 MFE_WARNING
33002003 MFE instance(s) still exist(s).
33002004 The MFE received an invalid pointer.
33002005 Type %I% is not a valid MFE type.
33002006 Type %I% is not a valid MFE edge type.
33002007 Type %I% is not a valid MFE face type.
33002008 Type %I% is not a valid MFE element type.
33002009 Topology engine is not available for MFE.
33002010 There is no association with the TE.
33002011 Item %I% exists in MFE.
33002012 Item %I% does not exists in MFE.
33002013 MFE received an invalid LM list handle.
33002014 Mbr for item %I% is not available.
33002015 Item %I% already has mbr.
33002016 Item size %I% for MFE type is too small.
33002017 Can't remove mfe item %I% type of %I%, it's still used by higher instances.
33002018 MFE received an invalid item label.
33002019 MFE received an invalid label for lower item.
33002020 Lower item does not exist.
33002021 MFE could not open the file for writing neutral file.
33002022 Invalid number of nodes for mfe item.
33002023 Mesh case %I% is invalid.
33002024 Requested item does not belong to this mesh case
33002025 MFE mesh case failure.
33002026 Matrix failure in MFE.
2096 PCL Reference Manual
Introduction
33040000 MSG_MFE_MOD
33043001 MSG_MFE_MOD_FATAL
33043002 Unknown fatal MFE modify failure.
33043003 MSG_MFE_MOD_LAST_FATAL
33052001 MSG_MFE_VERIFY_WARNING
33052002 No bad elements were found
33052003 MSG_MFE_VERIFY_LAST_WARNING
33053001 MSG_MFE_VERIFY_FATAL
33053002 MFE verify failure.
34000000 AUTOMESH
34000100 User requested abort in AutoTetMesh.
34001000 Unable to open AutoTetMesh parameter file
%A%.
34001001 No mesh created for body %A%.
34001002 Cannot continue writing AutoTetMesh mesh
parameter file for body %A%. Error occurred
on line %I%: "%A%"
34001003 User requested abort while writing an
AutoTetMesh mesh parameter file.
34001004 No UG part file accessed yet.
34001005 Mesh subdivision level of %I% not permitted.
Value must be in the range 1 to 5.
34001006 %A% has unacceptable subdivision level of
%I%. Value must be in the range 1 to 5.
34001007 Cannot locate the AutoTetMesh executable
"paroct".
34001008 The highlighted edges have illegal
Unigraphics Tags. The mesh parameter will
be ignored.
34001009 Starting the AutoTetMesher. The meshing
process may take a while.
34001010 Cannot open the scale file.
2100 PCL Reference Manual
Introduction
35000000 RT
35001001 RT_INFO
35001002 Answer to your question is no.
35001003 The Range Tree utility is not initialized.
35001004 Severity of the message %I% is unknown.
35001006 RT_LAST_INFO
35002001 RT_WARNING
35002002 Can't shut down RT with cells in trees.
35002003 Can't shut down RT with active trees.
35002004 Cell index %I% is not valid.
2104 PCL Reference Manual
Introduction
36000000 FILE
36000001 Cannot open database %A%. A database is already open.
36000002 Database %A% already exists. Do you wish to delete the existing database and create
a new one ?
36000003 Database %A% does not exist. Do you wish to create a new database ?
36000004 Database %A% already exists. Cannot create an existing database.
36000005 %A% File %A% already exists. Do you wish to delete the existing %A% file and create
a new one ?
36000006 Database %A% does not exist.
36000007 Reverting will remove all changes made during this session. Are you sure you want to
revert ?
Chapter 11: Status Messages 2105
Introduction
36002503 The face on element ID = %I% could not be determined from node IDS = %I%, %I%
for the PLOAD4 with SID = %I%.
36002504 The edge on element ID = %I% could not be determined from node IDS = %I%, %I%
for the PLOADX1 with SID = %I%.
36002505 The %A% in the load set map is not recognized for card type %I%.
36002506 There are no more load values.
36002507 The load set "%A%" could not be created because of a database error.
36002508 The element with ID = %I% could not be added to the application region for the %A%
card.
36002509 The node with ID = %I% could not be added to the application region for the %A%
card.
36002510 The load set name could not be retrieved from the database.
36002511 The property set name could not be retrieved from the database.
36002512 The variable name could not be found for the load set named "%A%".
36002513 The value could not be associated to the load set "%A%".
36002514 The PLOAD4 with SID = %I% cannot be imported for element ID = %I%, because
tractions are not supported on element faces.
36002515 An error occurred while trying to retrieve the connectivity for element ID = %I% from
the database.
36002516 The surface temperatures were not imported, because the element thicknesses could
not be determined.
36002517 The %A% surface temperature could not be imported for element ID = %I%, because
the thickness could not be determined for this element.
36002518 The transformation to the beam element system could not be performed for element ID
= %I%, because the element's orientation has not been defined. The PLOAD1 with
SID = %I% cannot be imported for this element.
36002519 The node ID = %I% is referenced in the %A% with SID = %I%, but the node does not
exist.
36002520 The magnitude of the vector that defines the beam orientation for element ID = %I%
is too small. The PLOAD1 with SID = %I% cannot be imported for this element.
36002521 The orientation for element ID = %I% could not be determined, because the length of
this element is too small. The PLOAD1 with SID = %I% cannot be imported for this
element.
36002522 The direction of the orientation vector is parallel to the axis of the beam for element ID
= %I%. The PLOAD1 with SID = %I% cannot be imported for this element.
36002523 The shape of element ID = %I% was not recognized when the %A% with SID = %I%
was imported.
Chapter 11: Status Messages 2111
Introduction
36002524 The transformation matrix could not be determined for element ID = %I%. The %A%
with SID = %I% cannot be imported for this element.
36002525 The transformation matrix could not be determined for element ID = %I%, because the
loaded edge is too small. The PLOADX1 with SID = %I% cannot be imported for this
element.
36002526 The node ID = %I% could not be found in the element connectivity for element ID =
%I%.
36002527 The face number %I% does not exist on element ID %I%.
36002528 The node ID = %I% does not exist on face number %I% for element ID = %I%.
36002529 The shape of face number %I% on element ID = %I% is not recognized.
36002530 The number of corner nodes specified for face number %I% on element ID = %I% is
incorrect.
36002531 The edge number %I% does not exist on element ID %I%. The %A% with SID = %I%
cannot be imported for this element.
36002532 The load set with SID = %I% could not be found in the database.
36002534 The application region does not exist for the "%A%" load set.
36002535 The element with ID = %I% could not be added to the application region for the
"%A%" load set. %I%.
36002536 The node with ID = %I% could not be added to the application region for the "%A%"
load set.
36002537 The data for this variable is null.
36002538 %I% Load Sets of type "%A%" written to database.
36002539 Filtering was not done on spc1 load sets.
36002540 The PLOAD1 with SID = %I% cannot be imported for element ID = %I%, because the
load does not span the entire length of the element.
36002541 The SCALE field on the PLOAD1 with SID = %I% is not recognized for element ID
= %I%. This load cannot be imported.
36002542 New coordinate frame %I% has been created for use in importing RFORCE with SID
= %I% at MSC Nastran GRID %I%.
36002543 The relation that maintains unique entities in the application region could not be
created for the load sets.
36002544 An RFORCE in set %I% applied to node %I% references a non-rectangular coordinate
frame; %I%. This load can not be imported.
36002550 The load case "%A%" could not be created because of a database error.
36002551 The loads and boundary condition counters can only be updated for a combination card
type.
36002600 The maximum allowable number of subcases has been exceeded. It is currently set to
%I%.
2112 PCL Reference Manual
Introduction
37000000 P/THERMAL
37000001 Input Error
37001001 Index error.
37001002 Only select one row, From row used.
37001003 Not the next index, Try again.
37001004 Index is not in valid range, Try again.
37001005 Independent Variable must be Increasing.
37001006 Independent Variable out of Range, Must be Monotonically Increasing.
37001007 Invalid option combinations have been selected.
37001008 A valid option has not been specified.
37001009 The data value must be less than or equal to 1.0.
37001010 The data value must be greater than or equal to 1.0E-5 and less than or equal to 0.5.
37001011 The data value must be greater than or equal to 3 and less than or equal to 16.
37001012 Both Radial and Centerline Axis for the axisymmetric geometry have been set to the
same global axis. This is not a valid combination.
37001013 No results template file has been defined.
37001014 No nodal results file has been specified.
2114 PCL Reference Manual
Introduction
37001061 Multiple term general fields are not translated as P/THERMAL micro function. This
field %A% will not be translated.
37001062 This is not a valid P/THERMAL micro function. This field %A% will not be translated.
37001071 The Fluid Node was not specified.
37001072 Requested Constant or Spatial data, but none was specified.
37001073 Requested Integer data, but none was specified.
37001074 No data was specified. Although any data not specified will have an assumed value of
1.0, At least one entry must be specified even if it has a value of 1.0.
37001100 When "Selection" is chosen for the order of coupled temperature LBCs, the second list
must have either one node or the same number of nodes as the first list.
37001101
Unable to allocate memory for direct translation of LBCs to Patran THERMAL files.
37001102 Error retrieving load set information.
37001103 Error opening %A% output file.
37001104 Error retrieving load case information for "%A%".
37001105 Error retrieving load set data from "%A%".
37001106 Error counting load set data from "%A%".
37001107 When "Selection" is chosen for the order of gap convection or gap radiation LBCs, the
second list must have only one node.
37001108
During direct translation of LBCs to Patran THERMAL files, was unable to find desired
element ID %I%. Translation aborted.
37001109 Invalid element type - %I% - was encountered During direct translation of LBCs to
Patran THERMAL files. Element ID was %I%. Translation aborted.
37001110 During direct translation of gap Convection of element %I% - Abort. Check previous
messages for more information.
37001111 During direct translation of gap Radiation of element %I% - Abort. Check previous
messages for more information.
37001112 During gap radiation direct translation node ID (%I%) was defined in both the
application and companion regions. This is not valid. Probably caused by more nodes
being selected at a common interface than belongs to the entity selected. Do you wish
to abort the translation?
37001113 During gap convection direct translation node ID (%I%) was defined in both the
application and companion regions. This is not valid. Probably caused by more nodes
being selected at a common interface than belongs to the entity selected. Do you wish
to abort the translation?
2116 PCL Reference Manual
Introduction
37001114 During direct translation of the temperature coupling LBC, node ID (%I%) was defined
in both the application and companion regions. This is not valid. Probably caused by
more nodes being selected at a common interface than belongs to the entity selected. Do
you wish to abort the translation?
37001115 Error retrieving Element Region Definition for "%I%" region ID and element "%I%".
Possible cause - element properties were not defined.
37001116 Unable to get the element property "%A%".
37001117 During translation of gap Radiation for element edges. Element %I% created this
condition - abort.
37001118 During direct translation of gap Radiation applied to element face %I% - abort.
37001119 Direct translation of gap Radiation applied to nodes is not supported. Ignore this
boundary condition for node %I%.
37001120 Direct translation of gap Radiation applied to this element type is not supported.
Element ID is %I% - abort.
37001121 During translation of gap Convection for element edges. Element %I% created this
condition - abort.
37001122 During direct translation of gap Convection applied to element face %I% - abort.
37001123 Direct translation of gap Convection applied to nodes is not supported. Ignore this
boundary condition for node %I%.
37001124 Direct translation of gap Convection applied to this element type is not supported.
Element ID is %I% - abort.
37001125 No region 1 entities were defined for %A% - abort translation. Probable cause: 1)
Incorrect entity type selected 2) Duplicate nodes defined in region 1 & 2. 3) Forgot to
complete FEM definitions. Examine previous error and warning message for more
information.
37001126 No region 1 entities were defined for loadset %A%. This loadset ignored. Probably
caused by forgetting to mesh some geometry or using the incorrect entity type. Most
common error is applying LBC to 2d entity when it is a solid face which should be a 3D
entity.
37001127 No region 2 entities were defined for loadset %A%. This loadset ignored. Probably
caused by forgetting to mesh some geometry or using the incorrect entity type. Most
common error is applying LBC to 2d entity when it is a solid face which should be a 3D
entity.
37001128 Duplicate nodes (%I%) were defined in regions 1 and 2 for loadset %A%. This is not
valid. Probably caused by more nodes being selected at a common interface than
belongs to the entity selected. Another cause is selecting neighbor while picking. Abort
translation.
37001129 An invalid condensation option (%I%) was specified while calculating the edge subarea
of element (%I%). Skip translation of this load set.
Chapter 11: Status Messages 2117
Introduction
37001130 A bad thickness option (%I%) for the entity region ID of (%I%). This occurred for a gap
boundary condition applied to a shell edge. Skip translation of this load set.
37001131 A bad field definition (%I%) was requested for data type (%I%) %A%. Skip translation
of this load set.
37001132 A bad element edge subarea calculation for element (%I%) with region ID of (%I%) and
condensation flag of (%I%). During %A%. Skip translation of this load set.
37001133 A bad element edge area calculation for element (%I%) and edge (%I%). Occurred
during %A%. Skip translation of this load set.
37001134 The independent variable must be Monotonically increasing. Data was only input in
first selected cell and focus was set to next cell in column.
37001135 There is no data in spread sheet. If don't what to create table, exit with CANCEL button
rather than OK.
37001136 There is empty data cell in the spread sheet. Please complete the table before activating
the OK button.
37001137 No Table Name was specified. Please define one.
37001150 The Micro Function name %A% with MFID = %I% already exist. Do you want to
overwrite?
37001151 The Micro Function Id, MFID = %I% belongs to Micro Function %A%. Can not have
two micro functions with the same Id. Creation aborted.
37001152 The Micro Function name %A% already exist. You are assigning a new Id, MFID =
%I%. Do you want to overwrite?
37001153 The Micro Function name requested - %A% is not valid. Specify a new name.
37001154 There was and Error creating a Micro Function. Operation was aborted.
37001155 Unable to find Field ID %I%, operation not completed.
37001156 The Field %A% is not a valid P/THERMAL micro function table, do not load it. Rather,
reset the form and continue. This field function can be modified through the fields menu.
37001157 Need a Micro Function Description.
37001158 The Micro Function Id, MFID = %I% already exist. Can not have two micro functions
with the same Id. Creation aborted.
37001160 The Material Property name %A% MPID = %I% already exist. Do you want to
overwrite?
37001161 The Material Property Id, MPID = %I% belongs to Material Property %A%. Can not
have two material properties with the same Id. Creation aborted.
37001162 The Material Property name %A% already exist. You are assigning a new Id, MPID =
%I%. Do you want to overwrite?
37001163 The Material Property name requested - %A% is not valid. Specify a new name.
37001164 There was and Error creating a Material Property. Operation was aborted.
2118 PCL Reference Manual
Introduction
37001165 The Field %A% is not a valid P/THERMAL material property table, do not load it.
Rather, reset the form and continue. This field function can be modified through the
fields menu.
37001166 Need a Material Property Description.
37001167 Creating monotonically increase table record.
37001168 The Material Property Id, MPID = %I% already exist. Can not have two material
properties with the same Id. Creation aborted.
37001180 There is no data in one of the Application Region %I%. This is not Valid. Select some
entities or exit through the cancel button.
37001181 The Select Application option can only have one (1) node or point entity defined until
such time as the list processor will not sort the entries. If multiple entries are desired,
use the Closest Approach option.
37001182 The Select Application option can only have one (1) Node or Point entity defined until
such time as the list processor will not sort the entries. If multiple entries are desired,
use the Closest Approach option. Otherwise the entity which has more than one node
per element must be replaced with a Point or Node.
37001183 During direct translation of Fixed Flux Heating on element %I% - Abort. Check
previous messages for more information.
37001184 During direct translation of Flux Heating Table on element %I% - Abort. Check
previous messages for more information.
37001185 Unable to calculate Surface Area for Element %I% - Abort. Check previous messages
for more information.
37001186 Unable to calculate Surface Edge Area for Element %I% - Abort. Check previous
messages for more information.
37001187 Unable to calculate Surface Face Area for Element %I% - Abort. Check previous
messages for more information.
37001188 The entity type which requested Surface Area calculations for Element %I% is not
supported - Abort. Check previous messages for more information.
37001189 An invalid condensation option (%I%) was specified for a Bar Element (%I%) while
attempting to calculate element subarea. Skip translation of this load set.
38000000 SGM
38000001 The allocated space for the blob is too small.
38000002 Input surface is not a four-sided surface.
Chapter 11: Status Messages 2119
Introduction
38000083 The Global Model Tolerance has been changed from %G% to the value of %G%
relative to the maximum object extents of %G%.
38000084 The Global Model Tolerance has been changed from %G% to the newly calculated
Global Model Tolerance of %G%.
38000100 %I% Points Created: %V%
38000101 %I% Point Created: %V%
38000102 %I% Curves Created: %V%
38000103 %I% Curve Created: %V%
38000104 %I% Surfaces Created: %V%
38000105 %I% Surface Created: %V%
38000106 %I% Solids Created: %V%
38000107 %I% Solid Created: %V%
38000108 %I% Trimmed Surfaces Created: %V%
38000109 %I% Trimmed Surface Created: %V%
38000110 %I% %A% Created: %A%
38000111 No Geometry Created.
38000112 Label %I% is illegal. Using label %I%.
38000113 %I% Solids Reversed: %V%
38000114 %I% Solid Reversed: %V%
38000115 No Solids Reversed.
38000116 Solid %I% has %I% degenerate edges. Geometry may not be suitable for meshing
operations.
38000117 An attempt to approximate a general curve with a single Parametric Cubic failed.
38000118 An attempt to approximate a general surface with a single Parametric BiCubic failed.
38000119 An attempt to approximate a general solid with a single Parametric TriCubic failed.
38000120 Invalid format conversion flag specified for curve conversion.
38000121 Invalid format conversion flag specified for surface conversion.
38000122 Invalid format conversion flag specified for solid conversion.
38000123 The input points for the creation of a surface are invalid.
38000124 Unable to extract current view matrix.
38000125 Unable to build the Shadow Surface.
38000126 Only one outer loop may be selected and at least one surface selected! %A%
38000127 CompTrimSurface Build Error -- Outer loop is not closed. Gap is %G%.
38000128 Unable to alloc memory to build the Composite Trim Surface.
38000129 Unable to project outer loop to Shadow Surface Plane.
Chapter 11: Status Messages 2121
Introduction
38000404 Unable to break Surface %I%. The Surface to break must be of a type different from
Composite Trimmed Surface.
38000405 Unable to break Surface %I%
38000406 The topology of input surfaces is inappropriate for the create/solid/face option.
38000407 The Sweep Arc Solid builder failed to create the evaluator table. Solid was not created.
38000408 The Sweep Glide Solid builder failed to create the evaluator table. Solid was not
created.
38000409 The Sweep Extrude Solid builder failed to create the evaluator table. Solid was not
created.
38000410 The Sweep Normal Solid builder failed to create the evaluator table. Solid was not
created.
38000411 The Construct Face Solid builder failed to create the evaluator table. Solid was not
created.
38000412 Negating the View Vector coordinates and trying again...
38000413 Zero length plane normal vector.
38000414 Invalid curve intersection method. Must be 1 or 2. Try again.
38000415 Skipping zero length Curve %I%
38000416 The input curve length of %G% is invalid. Input length value greater than zero.
38000417 The curve from which to create the normal has a tangent of length zero. Unable to create
curve.
38000418 The Arc radius must be greater than zero. Invalid value input was %G%
38000419 The angle of rotation must be non-zero.
38000420 The Arc start angle must be greater than 0 degrees. Invalid value input was %G%
38000421 The Arc end angle must be less than 360 degrees. Invalid value input was %G%
38000422 The Arc start angle must be less than the Arc end angle in order to maintain
counterclockwise angle convention. The invalid values input were %G% and %G%
respectively.
38000423 The three points specified are nearly collinear.
38000424 The center point and start point define a zero radius.
38000425 The Circle radius must be greater than zero. Invalid value input was %G%
38000426 The center point and start point define a zero radius.
38000427 The surface type used for this Action, Object, Method function is invalid. It must be of
a type that when created, has the default color of Green.
38000428 This application only works with one curve per surface at a time. Please adjust the input
accordingly.
38000429 This application only works with two points per surface at a time. Please adjust the input
accordingly.
2126 PCL Reference Manual
Introduction
38000430 The Sweep Extrude Surface builder failed to create the evaluator table. Surface was not
created.
38000431 The Sweep Glide Surface builder failed to create the evaluator table. Surface was not
created.
38000432 The Sweep Normal Surface builder failed to create the evaluator table. Surface was not
created.
38000433 A Zero length curve would have been created had the process continued. Modify
application input and try again.
38000434 The solid type used for this Action, Object, Method function is invalid. It must be of a
type that when created, has the default color of Blue.
38000435 This application only works with one surface per surface at a time. Please adjust the
input accordingly.
38000436 Specified Break Method value of %I% is invalid. Valid values are 1-4
38000437 The maximum error found while decomposing Solid %I% was %G%
38000438 No curves in the curve list define a unique least squares plane. Select a curve that is not
straight.
38000439 The selected curve %I% has no center of curvature. The curve cannot be extended into
a full circle.
38000440 Invalid 2D Arc2Point method. Must be 1 or 2. Try again.
38000441 A Zero length vector would have been created had the process continued. Modify
application input and try again.
38000442 The Radius value of %G% is too small for the input start and end points. Radius
magnitude must be at least %G%. Modify application input and try again.
38000443 The trim loop of a trimmed Surface is composed of edge curves which do not form a
closed loop in parameter (2D) space within tolerance.
38000444 The break curve can only intersect the outer boundary of the surface exactly twice.
38000445 There must be at least two curves as input to Chain. The invalid value input was %A%
38000446 Unable to decompose Surface %I%. The Surface to decompose must be of a type
different from Composite Trimmed Surface.
38000447 The two intersection planes are parallel.
38000448 The points in the point list do not define a unique least squares plane. Select points that
are not collinear.
38000449 No surfaces in the surface list define a unique least squares plane. Select a surface with
a positive area.
38000450 Unable to calculate a point on the curve.
38000451 Unable to calculate a point on the surface.
38000452 Unable to calculate a point on the solid.
Chapter 11: Status Messages 2127
Introduction
38000483 This application only works with one curve at a time. Subsequent selected curves will
be ignored.
38000484 There must be at least two surfaces in the surface list. The number input was %I%
38000485 The verification tolerance value of %G% must be less than or equal to the Geometric
Modeling Tolerance value of %G%.
38000486 %A% form a valid B-rep Solid.
38000487 The construction tolerance value of %G% must be less than or equal to the Geometric
Modeling Tolerance value of %G%.
38000488 Unable to manifold the curve(s) to the surface.
38000489 Unable to create a curve manifolded to the surface between the two input points.
38000490 No curves in the curve list define a plane to compute a normal projection vector from.
Specify a vector for projection or use the "Normal to Surface" Method.
38000491 There are no free surface edges.
38000492 Zero length vector in Solid %I% construction.
38000493 The Surface interpolating Solid builder failed to create the evaluator table. Solid was
not created.
38000494 The Curve interpolating Surface builder failed to create the evaluator table. Surface was
not created.
38000495 The Surface Extract Solid builder failed to create the evaluator table. Surface was not
created.
38000496 Unable to break Solid %I%
38000497 Unable to break a solid with the specified parametric position values of %G%, %G%,
and %G%
38000498 The surfaces are not correctly positioned to form a solid.
38000499 Unable to break a solid with the calculated parametric position values of %G%, %G%,
and %G% from the point coordinates of %G%, %G%, and %G%
38000500 Loading IGES file records...
38000501 Scanning %I% IGES file records...
38000502 Processing %I% IGES Entities...
38000503 Processing Transformation Matrix Entities...
38000504 Unable to open scratch file.
38000505 Unable to open IGES file %A%.
38000506 Unable to acquire IGES file size.
38000507 Unable to read IGES file %A%.
38000508 The specified file %A% is not a valid fixed (80 character) line length ASCII format
IGES file.
Chapter 11: Status Messages 2129
Introduction
38000509 The IGES file TERMINATE SECTION does not exist. According to the IGES
Specification, the last record in the IGES file must be the terminate record. Mandatory
corrective action has taken place in order for processing to continue on this IGES file.
38000510 Error parsing IGES file data. Invalid input encountered in REAL field.
38000511 Pointer to first curve of ruled surface definition is out of range. The ruled surface was
not processed. Check entity definition for bad pointer value.
38000512 Pointer to second curve of ruled surface definition is out of range. The ruled surface was
not processed. Check entity definition for bad pointer value.
38000513 Pointer to axis of revolution curve of surface of revolution definition is out of range.
The surface of revolution was not processed. Check entity definition for bad pointer
value.
38000514 Pointer to generatrix curve of surface of revolution definition is out of range. The
surface of revolution was not processed. Check entity definition for bad pointer value.
38000515 Pointer to directrix curve of tabulated cylinder definition is out of range. The tabulated
cylinder was not processed. Check entity definition for bad pointer value.
38000516 Unable to acquire %I% words of virtual memory.
38000517 Invalid form number: %I% associated with interpretation flag: %I% in COPIOUS
DATA entity definition. This entity will not be processed. Check entity definition for
invalid value.
38000518 Pointer to the Directory Entry line number of a Transformation Matrix (type number
124) used in defining a(n) %A% entity is an invalid value of %I%. This entity was not
processed.
38000519 Build error for circle #%I%.
38000520 CIR100: problem writing to scratch file.
38000521 An unsupported IGES curve type, %I%, was used to represent the inner boundary curve
on the surface that is to be trimmed. The trimmed surface (IGES type %I%) that is
referencing this curve will not be trimmed on its inner boundary.
38000522 An unsupported IGES curve type, %I%, was used to represent the outer boundary curve
on the surface that is to be trimmed. The trimmed surface entity (IGES type 144) that is
referencing this curve will not be trimmed on its outer boundary.
38000523 Build error for composite curve #%I%.
38000524 Build error for conic #%I%.
38000525 Improper or degenerate conic equation. Conic not processed.
38000526 An unsupported IGES curve type, %I%, was used to represent the inner boundary curve
on the surface that is to be trimmed. The trimmed surface entity (IGES type 144) that
is referencing this curve will not be trimmed on its inner boundary.
38000527 An unsupported IGES curve type, %I% , was used to represent the outer boundary curve
on the surface that is to be trimmed. The trimmed surface entity (IGES type 144) that
is referencing this curve will not be trimmed on its outer boundary.
2130 PCL Reference Manual
Introduction
38000528 Invalid form number, %I%, in COPIOUS DATA ENTITY definition. This entity will
not be processed. Check entity definition for invalid values.
38000529 Build error for copious data curve #%I%.
38000530 An invalid FORM number of 0 was defined for Copious Data Entity ( Type 106 ). A
Non-zero value is required for Entity Type 106. This Copious Data Entity was not
processed.
38000531 COPDAT: Error writing to NPSC.
38000532 Write error in lin110.
38000533 Build error for nurbs curve #%I%.
38000534 CIR2PC: A circle with 0 radius was read.
38000535 CON2PC: IFORM = 0
38000536 Error reading surface type %I% used in the definition of a Trimmed Surface Entity
(Type 144). Trimmed Surface was not processed.
38000537 Unsupported IGES surface entity type %I% was used to define a Trimmed Surface
Entity ( type 144 ). This entity was not processed.
38000538 IGES Curve type %I% is invalid for bounding a Trimmed Surface Entity. The Trimmed
Surface Entity was not processed.
38000539 RED144: Problem reading the IGES file.
38000540 RED144: Invalid trimming curve type.
38000541 RED144: Too many loops.
38000542 RED144: Nonzero IRC from REDNBC.
38000543 RED144: Surface has no trim curves
38000544 RED144: MEM_GET failure.
38000545 RED144: Nonzero IRC from BSSFBD.
38000546 RED144: Nonzero IRC from RED126.
38000547 RED144: Nonzero IRC from RED142.
38000548 RED144: Exceeded 400 segments.
38000549 RED144: Nonzero IRC from BSCVBD.
38000550 RED144: Nonzero IRC from REDTYP.
38000551 Trimming Loop is not closed for Trimmed Surface defined on Parameter Data Line
number %I% in the IGES file. The Trimmed Surface was not processed.
38000552 RED144: Nonzero IRC from RED114.
38000553 RED144: Nonzero IRC from S114BD.
38000554 RED144: Parent surface type not yet supported.
38000555 RED144: Nonzero IRC from RED120.
38000556 RED144: Nonzero IRC from S120BD.
Chapter 11: Status Messages 2131
Introduction
38000611
Exporting %I% Patran Solids by Group...
38000612 Error writing to IGES Export scratch file.
38000613 Error writing to IGES file.
38000614 Error generated in the call to the Offset Curve builder.
38000615 Error encountered parsing data for an IGES Offset Curve.
38000616 The curve type to be offset is not currently supported.
38000617 Error retrieving geometric entity definition of type PDA %A% from the database.
38000618 Error retrieving geometric entity definition of type IGES %A% from the database.
38000619 Database Error retrieving entity counts.
38000620 The Imported Model Scale has caused the Geometric Display Properties CHORDAL
TOLERANCE to be changed to %G%.
38000621 Trimmed Surface defined on Parameter Data Line number %I% in the IGES file is
degenerate. The Trimmed Surface was not processed.
38000622 Node ID %I% already exists in the database.
38000623 Element ID %I% already exists in the database.
38000624 Querying database for entity count...
38000625 Querying database completed.
38000626 An unsupported IGES curve type, %I%, was used as a constituent entity of a composite
curve. The Composite Curve entity (IGES type 102) that is referencing this curve was
not imported.
38000627 Parameter Data missing in Parameter Data Section on line number %I% for entity type
%I% ( %A% ). IGES file is invalid after this point. Contact Originating CAD Vendor
for validation of IGES file.
38000628
Patran IGES Access Export Terminated.
38000629
Patran IGES Access Import Terminated.
38000630 Copious data having IFORM = %I% is not supported for use as a constituent entity in a
composite curve.
38000631 The entity of type "%A%" on line number %I% of the Parameter Data section has
defined a pointer to the Directory Entry line number %I% which is not within the valid
range of 1 and %I%. This entity was not processed.
38000632 The domain of definition of a NURBS surface exceeds the range of its knot vectors. It
will be truncated to the domain of the knot vectors.
2134 PCL Reference Manual
Introduction
38000633 Child Bounded Planes are not supported directly through IGES Import. The internal
closed curve defining this Child Bounded Plane was written to the database. A Planar
Trimmed Surface can be created in Patran from the Parent Bounded Plane and its Child
Bounded Planes.
38000634 The parametric space trim curve type %I% lies outside the domain of definition of the
parent surface. The current trimmed surface will not be processed.
38000635 Unable to process the Curve on Surface entity defined on Parameter Data line number
%I% in the IGES file due to invalid combination of pointer data. The pointer to the 2D
curve is %I%, the pointer to the 3D curve is %I%, and the trimming preference flag is
%I%. The Trimmed Surface pointing to this entity was not processed.
38000636 ONE outer loop ( Composite Curve/Chain ) must be selected. Try again.
38000637 Cannot access geometry definition for %A%
38000638 Unable to decompose the Solid face due to a manifold error.
38000639 The specified IGES file is not a valid fixed (80 character) line length ASCII format
IGES file. The syntax error is caused by an invalid section identification character that
must occupy Column 73 of each line. Valid descriptors are S, G, D, P, T. The following
line caused the error: "%A%"
38000640 The IGES file Terminate Section sequence number for the Directory Entry Section does
not match the number of Directory Entry Section records. Mandatory corrective action
of changing the sequence number internally from %I% to %I% has taken place in order
for processing to continue on this IGES file. Contact Originating CAD Vendor for
validation of IGES file.
38000641 The IGES file Terminate Section sequence number for the Parameter Data Section does
not match the number of Parameter Data Section records. Mandatory corrective action
of changing the sequence number internally from %I% to %I% has taken place in order
for processing to continue on this IGES file. Contact Originating CAD Vendor for
validation of IGES file.
38000642
Exporting %I% Patran Planes...
38000643
Exporting %I% Patran Planes by Group...
38000644 The geometry/topology of surface %I% is such that it cannot be exported in its original
form. An attempt will be made to export the edge curves and the parent surface.
38000645 The Nurbs curve (type 126) defined on Parameter Data Line number %I% is degenerate
due to identical start and end parameter values. It will not be loaded into the database,
nor will any entity dependent on it. If this curve is subordinate, the line number given
refers to the nonsubordinate entity whose import will fail due to this error.
38000646 This group would be empty if created. Select the entity type(s) to be added to this group.
Chapter 11: Status Messages 2135
Introduction
38000647 This file contains Nurb surfaces of degree %I% or greater which have such potential for
instability that the Geometry Preference setting for NURBS_ACCELERATOR was set
to "OFF". Consult the CAD Vendor who created the IGES file to lower the order of the
NURBS surfaces.
38000648 This file contains Nurb curves of degree %I% or greater which have such potential for
instability that the Geometry Preference setting for NURBS_ACCELERATOR form
was set to "OFF". Consult the CAD Vendor who created the IGES file to lower the order
of the NURBS curves.
38000649 The combination of curve and axis selected as such that the resulting surface would have
flipping normal vectors and be of no practical use. Please check your inputs.
38000650 The data which you input to define this involute curve is improper. Please recheck it.
If you find no obvious errors, please consult the documentation for a thorough
explanation of the input quantities.
38000651 Solid (label = %I%) is not a triparametric solid (blue) and hence cannot be refit.
38000652 Solid (label = %I%) cannot be refit to within the specified tolerance.
38000653 Solid (label = %I%) cannot be refit within a maximum allowable space of 200000
words.
38000654 Solid (label = %I%) cannot be refit into less than 1000 hyperpatches for the specified
tolerance.
38000655 Unable to break %A%
38000656 Unable to break %A%. The surface must not be a composite trim.
38000657 An Error was encountered in reading the DIRECTORY ENTRY section - starting at line
number %I%. The affected entities in this file will not be imported. Check the IGES
specifications for valid field limitations.
38000658 The ID associated with an entity has exceeded 99999999 which is the largest value
allowed by the IGES specification. These entities will not be exported.
38000659 %A% is not a general trimmed surface.
38000660 %A% is not a chain
38000661 Warning. This surface may not be meshable. Do you wish to create it anyway?
38000662 Warning. Surface ID %I% may not be meshable.
38000663 Import of this IGES file must be aborted at this point due to a read error in the parameter
section. It is likely that this file has been accidently truncated.
38000664 Import of this IGES file must be aborted at this point due to a read error in the parameter
section - line %I%.
38000800 Group name is invalid. See documentation for definition of valid group name.
2136 PCL Reference Manual
Introduction
38000947 %A% is not allowed to be associated because an association to the curve/surface exists
with its duplicated point: %A%.
38001000 Is red colored curve specifying the outer boundary of the Composite Surface.
38001001 No outer boundary has been selected!
38001002 Problem 2: At the red square there is no boundary curve to continue and the loop is not
closed. The white square is showing the start location. White edges are already checked.
Red square is showing the current position. Possible Action: Add a curve connecting the
red square to a red boundary curve using the < Modify Boundary > tool .
38001003 Problem 1: At the red square there are more than one boundary curves to continue. The
white square is showing the start location. White edges are already checked. Red square
is showing the current position. Possible Action: Remove the appropriate edge using the
< Modify Boundary > tool.
38001004 Problem 3: The red and green vertices are not part of the selected surfaces; however, the
green vertices are within global tolerance and will be projected onto the surfaces.
Incorrect vertex placement may result in geometric incongruency. Okay to continue ?
38001005 No outer Loop has been defined !
38001006 Do You want to use the previous <ADD/REMOVE> list for the current boundary ?
38001007 Different colors in the boundary mean: White - free edges within the current surface
selection.Dark Blue - Edges are shared by two surfaces. Light Blue - Edges are shared
by more than two surfaces ( most likely a non-manifold edge). Red - Edges which are
not part of the boundary due to a gap or a branch.
38001008 The current cleanup tolerance < %G% > seems to be very small compared to the model
dimensions. You should consider changing it to a value near < %G% >. Do you want to
use and update the larger tolerance value ?
38001100 %I% %A% Edited: %A%
38001101 No Geometry Edited.
38001102 Unable to edit geometry. Illegal Edit Option.
38001103 Unable to edit the surface because it is used as the face of a solid.
38001104 Unable to close gap between surface %I% and %I% within tolerance. Can close gap to
%G%.
38001105 A gap of %G% exists between surface %I% and %I%. Do you want to close the gap?
38001106 The maximum gap size is %G%.
38001107 Unable to close gaps on surface %I% because it is a Unigraphics surfaces or a surface
based on a Unigraphics surface.
38001108 Unable to close gaps on surface %I% because it is a CADDS surfaces or a surface based
on a CADDS surface.
38001109 Unable to trim surface - the inner loop must lie within the outer loop. Note that an inner
loop surrounding a pole resolves the ambiguity based upon its orientation.
2140 PCL Reference Manual
Introduction
38001214 Unable to break the solid because failed to break one or more its faces. Slightly move
the splitting plane or surface and break the solid again.
38001215 Unable to break %A%. The plane may not intersect the curve.
38001216 Unable to break %A%. The plane may not intersect the surface.
38001217 Unable to break %A%. Errors occurred in breaking its faces. Check the intersections of
the solid faces with the splitting plane/surface. Then check if all faces, which the plane
or surface intersects, can be broken.
38001218 %A% does not intersect the plane or surface. Unable to break the Solid.
38001219 Unable to intersect the surface. Severe errors occurred during intersecting the surface.
38001220 Unable to associate elements to Non-parametrized Solid (Solid %I%).
38001221 This functionality is not supported for native parasolid surfaces (MDC_Surface ) in the
current release of Patran.
38001222
Parasolid MDC Surface types are not supported in the current release of Patran. The
following MDC_Surface types were found: %A%
38001223 Unable to find %A%.
38001224 No mesh and LBC's will be transformed because, during group transform, some
geometric entities have been changed their topology. Mesh and LBC's cannot be
associated with geometry. Use FiniteElements/Transform to transform mesh, then
associate them to geometry using FiniteElements/Association.
38001225 You are using a PRE_RELEASE feature -- the transformation of solid geometry
accessed by the Parasolid method. This feature should be used with caution. Do you
want to transform Solid %I%?
38001226 The transformation of solid geometry accessed by the Parasolid method is not supported
in this version. Solid %I% as well all Finite Elements and LBCs in this group will not
be transformed. To successfully transform the Finite Elements and LBCs, UNDO the
previous operation, remove this solid from the group and then re-apply the transform
operation.
38001227 Failed to transform Solid %I% as a solid. The FEM Elements and LBC's in this group
will not be transformed. To successfully transform the Finite Elements and LBCs,
UNDO the previous operation, remove this solid from the group and then re-apply the
transform operation.
38001228 Face normal returned from parasolid: %G%, %G%, %G% Face normal sense: %A%
38001229 Surface normal returned from parasolid: %G%, %G%, %G%
38001230 Input entity is not a valid parasolid kernel object
38001231 Input face entity is not part of the input brep entity
38001232 The curves provided for the surface edges are not contiguous due to a gap of %G%.
Either rebuild the curves to eliminate the gap or change the model tolerance to exceed
the gap dimension.
2142 PCL Reference Manual
Introduction
39000000 Journal
39000001 Journal file stopped recording at%A% %A%
39000002 Appending to existing journal file %A% at %A%
39000003 Creating journal file %A% at %A%
39000004 Journal file %A% does not exist. No journal file will be created.
39000005 Begin rebuilding database %A%.
39000006 Database rebuild complete.
39000007 Journal file name %A% conflicts with the original database name %A% that was
created. Database %A% will be created. Do you wish to continue?
39000008 Journal file name must end with ".db.jou"
Chapter 11: Status Messages 2143
Introduction
40000000 VEC
40001001 VEC_INFO
40001002 Severity of the message %I% is unknown.
40001003 VEC_LAST_INFO
40002001 VEC_WARNING
40002002 The Vector Utility received an invalid pointer.
40002003 Vector angle calculation failed.
40002004 Message code %I% does not belong to the Vector Utility.
40002005 Vector angle is indeterminate.
40002006 VEC_LAST_WARNING
40003001 VEC_FATAL
40003002 VEC_LAST_FATAL
40004001 VEC_CRASH
40004002 Undefined fatal Vector Utility failure.
40004003 VEC_LAST_CRASH
41000000 MTX
41001001 MTX_INFO
41001002 MTX_LAST_INFO
41002001 MTX_WARNING
41002002 The Matrix Utility received an invalid pointer.
41002003 Matrix type %I% is not yet supported.
41002004 Number of columns (%I) and rows (%) do not match.
41002005 This feature not yet available.
41002006 Singular matrix.
41002007 Severity of the message %I% is unknown.
41002008 Message code %I% does not belong to the Matrix Utility.
2144 PCL Reference Manual
Introduction
43000000 TE
43001001 TE_INFO
43001002 The Topology Engine is not initialized.
43001003 Point evaluated on surface is at boundary.
43001004 Point evaluated on surface is outside trimming curves.
43001005 Mapping by scaling parametric space is not feasible due to large distortions in the
mapping from parametric to global space.
43001006 TE_LAST_INFO
43002001 TE_WARNING
43002002 The Topology Engine received an invalid pointer.
43002003 TE has no instances for use id %I% type %I%.
43002004 TE received an invalid type code %I%.
43002005 TE received an invalid faceuse id %I%.
43002006 TE received an invalid edgeuse id %I%.
43002007 TE received an invalid world id %I%.
43002008 TE received an invalid body id %I%.
43002009 TE received an invalid shell id %I%.
43002010 TE received an invalid face id %I%.
43002011 TE received an invalid edge id %I%.
43002012 TE received an invalid vertex id %I%.
43002013 TE received an invalid loopuse id %I%.
43002014 TE received an invalid vertexuse id %I%.
Chapter 11: Status Messages 2145
Introduction
44000000 PDES
44001001 No express physical file open.
44001002 Express physical file already open.
2146 PCL Reference Manual
Introduction
44005001 The angle of rotation is not in the proper range: 0 < angle <= 95.
44005002 The included angle for the circle is less than or equal to zero or greater than 360
degrees.
44005003 The offset angle must not equal zero.
44008000 Element #%I% does not have the correct number of required nodes.
44008001 Element #%I% does not have the correct number of additional nodes.
44009000 Storing %I% %A% to the database.
44009001 Processing %I% Surfaces for %I% %A%.
45000000 NEUTRAL_EXPORT
45000001 Unable to open output file. Aborting Neutral File Export.
45000002 Error writing Finite Element Model. Will try to complete Neutral File.
45000003 Error writing Named Components. Aborting FEM portion of Neutral File. Will try
to complete writing geometry, if any.
45000004 Unable to open Neutral File: %A%.
45000005 Error counting NODES for Neutral File Packet 26.
45000006 Error counting ELEMENTS for Neutral File Packet 26.
45000007 Error counting MATERIALS for Neutral File Packet 26.
45000008 Error counting COORD FRAMES for Neutral File Packet 26.
45000009 Unable to write Neutral File Packet 26. Aborting FEM portion of Neutral File. Will
try to complete writing geometry, if any.
45000010 Error counting Property Regions in database. Aborting FEM portion of Neutral File.
Will try to complete writing geometry, if any.
45000011 Error Allocating Memory in Neutral File Export.
45000012 Error getting Nodal Data, Aborting FEM portion of Neutral File. Will try to
complete writing geometry, if any.
45000013 Error translating Nodal Data, Aborting FEM portion of Neutral File. Will try to
complete writing geometry, if any.
45000014 %I% Nodes written to the Neutral File.
45000015 Error getting Element Data, Aborting FEM portion of Neutral File. Will try to
complete writing geometry, if any.
2148 PCL Reference Manual
Introduction
45000016 Error getting Element Property Data, Aborting FEM portion of Neutral File. Will try
to complete writing geometry, if any.
45000017 Error translating Element Data, Aborting FEM portion of Neutral File. Will try to
complete writing geometry, if any.
45000018 %I% Elements written to the Neutral File.
45000019 Error translating Coord Frames, Aborting FEM portion of Neutral File. Will try to
complete writing geometry, if any.
45000020 %I% Coordinate Frames written to the Neutral File.
45000021 Error translating Loads, Aborting FEM portion of Neutral File. Will try to complete
writing geometry, if any.
45000022 Unable to write record to Neutral File. Aborting this record.
45000023 Error getting coordinate frame %I%.
45000024 Error writing a record to Neutral File.
45000025 Error in <%A%> call.
45000026 Model has no Element Property Regions Defined.
45000027 Material <%A%> being translated now.
45000028 Internal Ply Count conflict for Material <%A%>. Material not translated.
45000029 No elements in region %I%. No properties translated.
45000030 Error getting Property Values in Region %I%
45000031 Property table overflow. Aborting Property Translation
45000032 Third node, (ID = %I%) for bar orientation is not present.
45000033 Illegal DOF in pin flag <%A%>, at bar end %I%.
45000034 Illegal beam orientation vector for Property Region %I%.
45000035 Translating Loadtype <%A%> for Loadset <%A%>.
45000036 Element %I% not defined for Load <%A%>.
45000037 Node %I% not defined for Load <%A%>.
45000038 Load Type %I% not supported for <%A%>.
45000039 Unable to determine a unique 12 character Neutral File name.
45000040 Error in material property angle for 2D element.
45000041 The materials <%A%> and <%A%> map to the same neutral file material id. The
MID for the second material has been changed to %i%.
45000042 Vfac Template ID & Enclosure ID is a required input for Viewfactor boundary
condition.
45000043 At least two data inputs are needed for Convection boundary condition, one of them
has to be the Fluid node ID.
Chapter 11: Status Messages 2149
Introduction
45000044 Mapping of element property names to specific property ID's will not be performed
because at least one property has a Field reference.
45000045 Mapping of element property names to specific property ID's will not be performed
because at least two property names would map to the same ID.
45000046 Mapping of element property names to specific property ID's will not be performed
because property name <%A%> results in an undefined ID.
45000047 Mapping of load case names into specific neutral file set ID's will not be performed
because at least two names would map to the same ID.
45000048 Mapping of load case names into specific neutral file set ID's will not be performed
because Loadcase <%A%> results in an undefined ID.
45000049 Neutral export of the nodal field defined for property %I% in region %A% is not
currently supported.
45000050 Error translating MPC Data, Aborting FEM portion of Neutral File. Will try to
complete writing geometry, if any.
45000051 %I% MPCs written to the Neutral File.
45000052 Scale factors on the Load Case prioritization form are not currently supported for
this preference. Values defined for load case %A% are being ignored.
45000098 You are exporting a partial Neutral File which might not import back into PATRAN
3 unless other portions of the model are re-created first.
45000099 Neutral File export completed successfully.
45000100 Neutral File export completed with error(s). Please review the session file for details.
Please also be careful with the way you use the neutral file.
45000101 The Node Id is greater than 99999999.
47000000 RemoteProcedureCalls
47000001 RPC memory allocation error.
47000002 RPC Unknown server name.
47000003 RPC client create failure.
47000004 RPC server already exists.
47000005 RPC data type error.
47000006 RPC end of data input stream.
47000007 RPC unknown data type.
47000008 RPC client call failure.
2150 PCL Reference Manual
Introduction
48000000 List
48000001 "* %A% *" is not a valid target list !
48000002 "* %A% *" is not a valid boolean operator !
48000003 No Element found !
48000004 No Node found !
48000005 No Point found !
48000006 No Curve found !
48000007 No Surface found !
48000008 No Solid found !
48000009 No Material selected !
48000010 No Group selected !
48000011 No Property selected !
48000012 No Coord Value selected !
48000013 Boolean listc is empty !
48000014 "* %A% *" is not a valid Value option !
48000015 "* %A% *" contains no specified input data!
48000016 "Input List is empty !"
48000017 No Mpc found !
48000018 Group "* %A% *" does not exist !
49001160 A value that was not a valid number was detected in the Stress Distribution spread
sheet.
49001161 Fast Analysis is not valid when using rainflow matrices.
49001162 User must select a result load case and associated tensor.
49001163 User must select PSD file.
49001164 User must select a PSD matrix file.
49001165 Vibration fatigue analysis currently supports stress tensor type results only. Please,
make sure you have select the appropriate results type.
49001166 These cells will automatically be filled with appropriate load PSD from the selected
PSD matrix file. Entries can not be changed by user.
49001167 The maximum number of input load PSD supported at the present is twenty(20).
49001168 Error: Inconsistent frequency number for multiple load cases considered. Make sure
the recovered frequencies from FE analysis per load case is the same for all load cases.
49001301 First argument must be the jobname!
49001302 End of PAT3FAT translation.
49001303 Messages output from the %A% translator: %A% %A% on %A% at %A%.
49001304 Total execution time in real seconds: %G%
49001305 Total execution time in CPU seconds: %G%
49001306 ***Error: Not able to open message file.
49001307 ***Error: Not able to open .fin file.
49001308 ***Error: Not able to open .fnf file.
49001309 ***Error reading .fin file. Check message file.
49001310 ***Error reading .fnf file. Check message file.
49001311 ***Error writing .fes file. Check message file.
49001312 ***Error: Not able to open .vec file.
49001351 ***Job aborted due to user request.
49001352 PAT3FAT reading the FIN file...
49001353 PAT3FAT reading the FIN file...
49001354 PAT3FAT reading the FNF file...
49001355 PAT3FAT reading the FNF file...
49001356 PAT3FAT reading the FE results...
49001357 PAT3FAT reading the FE results...
49001358 PAT3FAT writing the FES input file...
49001359 PAT3FAT writing the FES input file...
49001360 PAT3FAT terminated normally.
2154 PCL Reference Manual
Introduction
49001423 ***Error: Invalid FACTOR OF SAFETY value detected. It must be either YES or NO.
49001424 ***Error: Invalid SURFACE STRESS EXTRACTION value detected. Must by either
YES or NO.
49001425 ***Error: Invalid PLANE_STRESS value detected. It must be either YES or NO.
49001426 ***Error: Invalid TRANSFORMATION value detected. It must be either NONE or
BASIC.
49001427 ***Error: An invalid load case ID has been detected in a FE LOAD CASE ID card.
The ID must look like "n.n-" when referencing database results.
49001501 ***Error: It appears that the .fnf file is not a properly formatted neutral file. The first
record must be packet type 25.
49001502 ***Error: No data of set IDs %I% - %I% found in the neutral (.fnf) file. Make sure at
least one group of nodes and/or elements has been defined for fatigue properties.
49001503 ***Error: No nodes or elements appear in the .fnf neutral file packet 26 summary. Not
able to allocate memory.
49001504 ***Error allocating memory in neutral file (.fnf) read routine.
49001505 ***Error allocating memory in fin file (.fin) read routine.
49001551
***Error reading the Patran FEA results file.
49001552
***Error: There are no nodal stress/strain results in the indicated Patran FEA results
file.
49001553
***Error: There are no load cases in the indicated Patran FEA results file.
49001554
***Error: There are no static results in the Patran FEA results file.
49001555
***Error: There are no transient results in the Patran FEA results file.
49001556 ***Error: The number of time steps requested exceeds the number of time steps in the
Patran FEA results file.
49001557 ***Error allocating memory in FE results read routine.
49001558
***Error reading Patran FEA results for load case header for load case/step number
%I%.
49001559
***Error reading Patran FEA results for load case/time step number %I%.
49001560
***Error: There are no Patran FEA results for shell elements in the results file.
49001561
***Error opening the specified Patran database.
2156 PCL Reference Manual
Introduction
49001562 ***Error in external results file name(s). There must be a "#" in the place of the load
case or time step number.
49001563 ***Error reading an external results file. See the message file.
49001564 ***Error opening external file %A%, for load case %I%.
49001565 ***Error reading external file header in file %A% for load case %I%.
49001566 ***Error reading external results in file %A% for load case %I%.
49001567 ***Error closing external file %A%, for load case %I%.
49001601 ***Error allocating memory while writing output (.fes) file.
49001602 ***Error creating (opening) the fatigue input file (.fes).
49001603
***Error opening Patran FEA (.res) results file.
49001604 ***Error writing the header to the .fes file.
49001605 ***Error writing stress/strains data to .fes file.
49001606 ***Error closing the fatigue input file (.fes).
49001621
***Error reading results from the Patran database.
49001622 ***Error: No global variables of type "Time" are associated with results case
%I%.%I%.
49001623 ***Error: There are no appropriate stress/strain tensor results associated with results
case %I%.%I%.
49001624 Using results type "%A%" of ID %I% for database results case %I%.
49001625 ***Error allocating memory to read database results.
49001626 ***Error: Results load case %I%.%I% is associated with Nodes yet and Elemental
based fatigue analysis has been selected. This is not possible at this time!
49001627 ***Error: There are no elements in the model. Cannot continue with translation.
49001628 ***Warning: No stress/strain tensor result types were encountered appropriate for
nodal fatigue calculations. Try changing the RESULTS LOC. to "Element" in the
General Setup Parameters.
49001629 ***Warning: No stress/strain tensor result types were encountered appropriate for
elemental fatigue calculations. Try changing the RESULTS LOC. to "Node" in the
General Setup Parameters.
49001630 Surface stress/strain extraction has been initiated by detection of normal vectors file.
49001631 ***Error: There are no nodes in the model.
49001632 ***Error reading the ".vec" file.
49001633 ***Error: There are more nodes in the ".vec" file than there are in the model.
49001634 ***Error allocating memory for surface stress/strain extraction.
Chapter 11: Status Messages 2157
Introduction
49001635 Warning: The system environment variable p3fpath has not been set properly. No job
submission or module spawning will be possible!
49001636
PAT3FAT collecting model data from Patran db...
49001637
PAT3FAT collecting model data from Patran db...
49001638 ***Error: The material informational parameters must be preceded by an S-N DATA
SET or MATERIAL .fin file.
49001639 ***Error: Too many materials are defined in the .fin file.
49001640 ***Error: No materials are defined in the .fin file.
49001641 ***Error: Invalid AVERAGING METHOD value detected. It must be either
GLOBAL OR GROUP.
49001642 ***Error: Invalid SURFACE FINISH value detected. It must be one of the 4 valid
options.
49001643 ***Error: Invalid SURFACE TREATMENT value detected. It must be one of the 10
valid options.
49001644 ***Error: Invalid WELD FLAG value detected. It must YES or NO.
49001645 ***Error: Invalid METHOD BIAXIAL value detected. It must NONE/MATERIAL
PARAMETER/HOFFMAN SEEGER.
49001646 ***Error: Invalid PLASTICITY value detected. It must NEUBER/MERTEN-
DITTMAN/SEEGER-BESTE.
49001647 ***Error: Invalid STRAIN TYPE value detected. It must TENSOR or
ENGINEERING.
49001648 ***Error: Failed trying to recover the total number of entities to be processed, from
the Patran DB.
49001649
***Error: Failed to recover id's from the Patran DB when trying to build list to be
processed.
49001650
***Error: Failed trying to recover the group id for a material region, from the Patran
DB.
49001651 ***Error: Failed trying to recover the number of entities in the material group, from
the Patran DB.
49001652 ***Error: Failed trying to recover the list of entities in the material group, from the
Patran DB.
49001653 ***Error allocating memory in routine that recovers model data.
49001654 ***Warning: Could not find "Stress" or "Strain in the the labels of any results types.
Using first available tensor result. This could be in error.
2158 PCL Reference Manual
Introduction
49002000 Results from attached xdb file are not currently supported.
49003001 Fatal errors encountered trying to read universal file.
49003002 Currently universal file reader will read following informatio: 1-All FEM. 2-All tensor
results. 3-All groups.
49003003 Unable to read Universal File card 2420, Coordinate systems. Check history window
for more details.
49003004 Unable to read Universal File card 2411, Finite Element model nodal information.
Check history window for more details.
49003005 Unable to read Universal File card 2412, Finite Element model element information.
Check history window for more details.
49003006 Unable to read Universal File card 2414, results data. Check history window for more
details.
49003007 Unable to read Universal File card 2430, grouping information. Check history window
for more details.
49004000 Number of input psd loading for vibration fatigue analysis is zero.
49004001 Number of frequency steps for vibration fatigue analysis is zero.
49005000 Group %A% must have bar elements and associated nodes only. Please, modify group
content to comply with this requirement.
49006000 MSC.Fatigue Module %A% does not have a valid license on this machine. Please,
verify that that the license is current.
49006500 Selected group %A% for material region does not exit in database.
49006501 Material region %A% contains MPC related free nodes that have no elements
associated with them, and no results. It is required that these be removed from the group
for a successful fatigue run
50000000 TEAM
50001001 TEAM_INFO
50001003
Are you sure you want to abort Patran TEAM job "%A%"?
50001004 Abort request submitted. Waiting for TEAM to actually abort processing.
50001005
The Patran TEAM Results Postprocessor is invoked as a separate standalone process, and
the database must be shutdown before proceeding.
50001006 TEAM_LAST_INFO
Chapter 11: Status Messages 2159
Introduction
50002001 TEAM_WARNING
50002002 The geometric boundary element subdivision (GBES) file, "%A%", is still open. Save
changes before exiting?
50002003 Load set "%A%" has a zero load vector. Check the load definition to make sure the
appropriate field has been specified. Continue processing?
50002004 Load set "%A%" has a non-zero X or Z velocity component. For axisymmetric analyses,
only the Y component should be specified for angular velocity. Continue processing?
50002005 Load set "%A%" has a non-zero X or Y velocity component. For 2D plane stress or plane
strain analyses, only the Z component should be specified for angular velocity. Continue
processing?
50002006 Load set "%A%" has an unrecognized load type "%A%". Recreate the load set, assuring
that the analysis preference is set to Patran TEAM at the time. Ignore load and continue?
50002007 The following team data file for the specified job already exists: %A%. When running a
full analysis, we recommend beginning with an empty dataset. OK to delete this file?
50002008 The Advanced Controls file, %A%, exists, but the analysis type flag in the file indicates
that this should be a Restart Run. Either delete the file and continue, or re-submit the
analysis as a Restart Run. Delete and continue?
50002009 TEAM_LAST_WARNING
50003001 TEAM_FATAL
50003002 Jobname "%A%" does not exist. An existing jobname is needed for this operation.
50003003 Jobfile "%A%" does not exist. An existing jobfile is needed for this operation.
50003004 Error parsing the solid specification "%A%". Either a blank or an invalid solid has been
specified. Please select a valid solid before continuing.
50003005 Error parsing the surface specification "%A%". Either a blank or an invalid surface has
been specified. Please select a valid surface before continuing.
50003006 Error parsing the curve specification "%A%". Either a blank or an invalid curve has been
specified. Please select a valid curve before continuing.
50003007 No loadcase has been specified. Please select a loadcase before continuing.
50003008 The specified jobfile "%A%" does not contain a proper definition of the TEAM model
specification, defined by the "REGION LABEL" parameter.
50003009 Unable to create a TEAM mailbox for model "%A%". Communications cannot be
established.
50003010 The material specified for this job, "%A%", is not valid. Make sure that a valid material
has been created and specified in the analysis setup.
2160 PCL Reference Manual
Introduction
50003011 More than one symmetry BC has been defined in the specified load case. Only one
symmetry BC may be specified. Either remove the unwanted symmetry BCs from the
load case, or combine them into one definition, before continuing. The Patran TEAM job
will not be submitted.
50003012 No material has been specified. Please select a material before continuing.
50003013 A mass density greater than zero must be specified for analyses with inertial loads. The
mass density specified for material "%A%" is %F%. Please modify this value
appropriately.
50003014 TEAM_LAST_FATAL
50004001 TEAM_CRASH
50004003 TEAM_LAST_CRASH
51000000 UTIL
51000001 Invalid pointer passed to function memcpy
51000002 Failure of C library function memcpy
51000003 Number of array elements to copy is < 0
51000004 Failure of C library function memset
51001000 %A% is not a valid entity.
51001001 This query requires Reference %A% be a %I%-dimensional entity.
51001002 The specified normal deviation exceeds the valid range for interior angle
computation between two vectors. The valid range is 0.0 <= deg <= 180.0.
51001003 Either no reference entity was provided or multiple reference entities were selected.
Only one reference entity may be specified.
51001004 The specified reference entity %A% does not satisfy the specified query criteria.
Although this entity will still be used to facilitate the query, it will be omitted from
the list of entities satisfying the query criteria.
51001005 This query could not find any element faces which satisfy the selection criteria.
Chapter 11: Status Messages 2161
Introduction
52000000 SGM_CV
52000001
Cannot open this database with standard Patran. Quit Patran and use p3.cv.
52010000 Failure occurred in CADDS Access %A%.
52010001 Successful execution of CADDS Access.
52010002 Opening CADDS database %A%
52010003 Closing CADDS database %A%
52010004 CADDS database cannot be opened due to the fact that it already exists and is open
or cannot be found.
52010005 Error in opening CADDS database %A%
52010006 Error in closing CADDS database %A%
52010007 Error in CADDS database handle %A%
52010008 CADDS filename error. Filename is %A%.
52010009 CADDS list handle error occurred. HANDLE is %I%.
52010010 CADDS entity handle error. HANDLE is %I%.
52010011 CADDS point handle error. HANDLE is %I%.
52010012 CADDS line handle error. HANDLE is %I%.
52010013 CADDS curve handle error. HANDLE is %I%.
52010014 CADDS uv curve handle error. HANDLE is %I%.
52010015 CADDS surface handle error. HANDLE is %I%.
52010016 CADDS vertex handle error. HANDLE is %I%.
52010017 CADDS edge handle error. HANDLE is %I%.
52010018 CADDS loop HANDLE error. HANDLE is %I%.
52010019 CADDS face HANDLE error. HANDLE is %I%.
52010020 Error in writing CADDS database.
52010021 Error in getting 1st point of line. HANDLE is %I%.
52010022 Error in getting 2nd point of line. HANDLE is %I%.
52010023 CADDS curve evaluator error for t1 occurred.
52010024 CADDS curve evaluator error for t2 occurred.
52010025 CADDS surface evaluator error for umin occurred.
52010026 CADDS surface evaluator error for umax occurred.
2162 PCL Reference Manual
Introduction
53000000 MASP
53000001 The axisymmetric coordinate frame cannot be spherical.
53000002 The reference coordinate frame must be rectangular.
53000003 The specified axes for the axisymmetric modeling frame are unreasonable.
53000004 The specified axes for the axisymmetric modeling frame are both %I%. The
axisymmetric frame is, therefore, not well-defined.
53000005 You have requested to specify your region by groups, but the group list is empty.
53000006 An unsupported widget value has been selected for the %A% widget.
53000007 Unable to obtain model definition data from the database.
53000008 The specified region contains no entities.
53000009 Unable to fetch group "%A%" from the database.
53000010 A database error occurred while attempting to fetch an element property region for
"%A%".
53000011 There is no default analysis code in the database. This is a problem with database
template initialization.
53000012 A database error occurred while attempting to fetch the physical property ID's for
element property region %I% having entities of dimension %I%.
53000013 A database consistency error occurred while attempting to fetch physical property
%I% of element property region %I%.
53000014 Unable to perform a database fetch of a coordinate frame (Internal ID = %I%).
53000015 Unable to fetch the definition data for element property region %I%.
53000016 Unable to fetch the properties of material %I%.
53000017 Unable to fetch the definition for %A% %I%.
53000018 Unable to perform a database fetch of a coordinate frame (Internal ID = %I%)
referenced by a concentrated mass.
53000019 Unable to fetch the coordinates of a point to determine the location of a concentrated
mass.
53000020 Unable to fetch the coordinates of a 0D element.
53000021 Unable to initialize field %I% for evaluation.
53000022 A programming error has occurred while attempting to process a solid entity in an
axisymmetric model. An earlier filter should have prevented this. For a workaround,
please do not specify any such entities for mass properties calculation.
53000023 The net mass in the region specified is zero.
2164 PCL Reference Manual
Introduction
53000024 Not all of the calculated principal inertias, %F%, %F%, and %F%, are positive.
53000025 Unable to allocate %I% bytes of virtual memory.
53000026 No mass properties can be calculated for any of the entities in the specified region.
The reasons are given in the ensuing warning messages. Check the History window
for multiple warning messages.
53000027 None of the entities in the specified region is compatible with the requested analysis
type.
53000028 The list of included entities could not be generated.
53000029 The list of rejected entities could not be generated.
53000030 Some of the specified entities were excluded from the mass property calculations
because no element property region has been specified for them.
53000031 Some of the specified entities were excluded from the mass property calculations
because they are not consistent with the specified analysis model type.
53000032 Some of the specified entities were excluded from the mass property calculations
because they have no material assigned to them in their element property records.
53000033 Some of the specified entities were excluded from the mass property calculations
because some of their needed element properties are not found or represented using
data types that are supported by the Mass Properties.
53000034 Some of the specified concentrated mass elements have inertia tensors specified in
non-rectangular frames. These inertia tensors are assumed to be defined on a
rectangular frame whose axes are coincident with the axes of the specified non-
rectangular frame.
53000035 Some of the specified tapered beams were excluded from the mass property
calculations because their element property records have non-constant cross-
sectional areas.
53000036 Some of the specified entities were excluded from the mass property calculations
because their element property definitions lack a needed physical property such as
shell thickness or beam cross-sectional area.
53000037 Some of the specified entities were excluded from the mass property calculations
because they have neither material density nor nonstructural mass.
53000038 Some of the specified point entities were excluded from the mass property
calculations because they have no mass.
53000039 Some of the specified entities were excluded from the net mass property calculations
because errors occurred in the numerical integration of their mass properties. This is
often caused by a shortage of available virtual memory or a property defined by a
field that cannot be integrated over the entity.
53000040 The coordinate frame aligned with the principal axes of inertia could not be
generated. This is usually an indication of a corrupted database or a lack of available
virtual memory.
Chapter 11: Status Messages 2165
Introduction
53000041 The specified entities that were excluded because of the indicated warning conditions
are: %A%
53000042 The principal axes of inertia cannot be plotted.
53000043 Unable to calculate a normal for 2D element %I%.
53000044 Unable to process the geometric definition for %A% %I%.
53000045 Unable to calculate a normal for %A% %I%.
53000046 The modeling plane cannot be uniquely determined from the entities specified.
53000047 Some of the specified entities were excluded from the mass property calculations
because they are not planar.
53000048 A normal to the axisymmetric modeling plane cannot be determined.
53000049 Some of the specified entities were excluded from the mass property calculations
because they are not in the modeling plane.
53000050 Unable to evaluate a point relative to the 2D modeling plane.
53000051 Unable to evaluate a point of %A%.
53000052 None of the principal directions is orthogonal to the 2D modeling plane.
53000053 Loading geometry data into memory...
53000054 Loading element properties into memory...
53000055 Performing mass property calculations...
53000056 Loading data from materials...
53000057 Unable to complete the Mass Properties report file. Failure occurred while
attempting to write: %A%
53000058 Unable to allocate virtual memory.
53000059 Some of the specified entities were excluded from the net mass property summation
because their calculated mass is zero. This problem can occur when a property is
defined by a field that cannot be integrated over the entity.
53000060 Some of the specified entities were excluded from the net mass property summation
because their calculated volume is zero. The excluded entities are not point entities,
so their calculated mass must also be zero. This problem can occur when the wrong
modeling plane is specified for an axisymmetric model or when part of an entity
crosses the axis of symmetry.
53000061 The calculated principal directions and associated rotation angles are wrong. The
principal inertias may also be wrong.
53000062 Some of the concentrated masses have the moments of inertia defined. This can cause
counter-intuitive results to occur when the 2D Axisymmetric analysis type is
selected. The input moments of inertia are treated as moment of inertia densities and
are multiplied by 2*PI*radius to determine their contribution to the net inertia tensor
of the concentrated mass. The resulting inertia tensor may not correspond to that of
an axisymmetric body.
2166 PCL Reference Manual
Introduction
53000063 Some of the referenced element properties define an offset. All offsets are ignored in
the calculation of mass properties. This can cause the results to change substantially.
53000064 Not all of the principal axes of inertia can be plotted. Their lengths are determined
by the three radii of gyration corresponding to the three principal inertias, and some
of these are zero.
53000065 Unable to evaluate the area of %A%.
53000066 Some of the materials referenced by the specified entities have density defined by a
field. Density fields are not supported for mass property calculations. Entities
referencing a density field will be assigned a density of zero.
53000067 The specified axis of symmetry divides the specified model. Mass properties can
only be calculated when all of the specified entities are on the same side of the
symmetry axis.
53000068 A database error occurred while attempting to fetch the element property regions for
the specified entities.
53000069 Unable to display newly created principal coordinate frame %I%.
53000070 Zero-dimensional entities are not included in the mass property calculations if you do
not specify that Element Properties are to be used to determine density and
concentrated mass. Consequently there are no valid entities in the specified region.
53000071 The specified zero-dimensional entities were excluded from the mass property
calculations because the Unity option for Density/Concentrated Mass was selected.
Under these circumstances, zero-dimensional entities are ignored.
53000072 Mass property calculation has been aborted at the user's request.
53000073 Some of the entities specified do not exist.
53000074 Since Element %I% is associated to %A% %I%, properties for both entities will be
used in the mass property calculations. Continue anyway?
55000000 PPI
55000001 Unable to allocate memory.
55000002
Patran is not presently running.
55000003 The device or file accessed is not valid.
55000004 A PPI session has not been initiated.
55000005 The handle accessed is not a session handle.
55000006 The handle accessed is not a file handle.
Chapter 11: Status Messages 2167
Introduction
56000000 DB_IMPORT
56000001 DB_IMPORT_ABORT
56001001 DB_IMPORT_INFO
56001002 Loading %I% "%A%" entities.
56001003 Loading all referenced entities.
56001004 Saving %I% entities.
56001005 Equivalencing duplicate %A%.
56001006 %I% duplicate %A% deleted.
56001007 Posting all entities.
56001008 ... %A% label %I% (internal ID=%I%)
56001009 LoadBC "%A%" imported from LoadCase "%A%" does not have the same scale
factor as the current database. Current scale factor left unchanged.
56001010 Group name "%A%%A%" truncated to "%A%".
56002001 DB_IMPORT_WARNING
56002002 %A% %I% already exists in the current database. If it is equivalent to %A% %I%
from the import database, then continue to allow geometric equivalencing to resolve
the conflict; otherwise, this import cannot continue. Continue this import?
56002003 %A% %A% already exists in the current database. Since the %A% Merge option is
OFF, then an extended name, %A%, must be used.
56002004 Unable to open the import summary file: "%A%".
56002005 The minimum length of non-degenerate curves and edges being imported is %F%.
Since this value is less than twice the specified equivalence tolerance of %F%, it is
possible for non-degenerate curves to collapse into degenerate curves during import.
A new equivalence tolerance of %F% has been calculated (half of the minimum
curve/edge length). Select YES to use the new tolerance; NO to use the original
tolerance; or ABORT to discontinue the import.
56002006 An error occurred while attempting to load reference %A% (internal ID=%I%) from
the import database. Though this entity is referenced by an existing entity, it does not
appear to exist. If you have not experienced any problems with the import database,
then there is no cause for alarm. The reference will be removed upon import. Entity
traceback from the import database follows (command window only):
56002007 The Load/BC type definition for Load/BC %A% has not been loaded in the target
database. This Load/BC cannot be transferred until the appropriate analysis code
preference, defining this Load/BC type, has been loaded. Continue the import without
this Load/BC?
2170 PCL Reference Manual
Introduction
56003007 %A% error occurred while %A% %A% %A% from the import database to %A%
%A% in the current database. Unable to continue.
56003008 %A% %I% already exists in the current database. This import cannot continue.
56003009 %A% %I% already exists in the current database. If it is equivalent to %A% %I%
from the import database, then turn on Geometric Equivalencing within the
Equivalencing Options form, and try the import again. This import cannot continue
56003010 The import database schema version (%A%) is not compatible with that from the
current database (version %A%). Please make sure the import database is upgraded
to schema version %A% by assuring that it has been successfully opened and saved
by this version of Patran.
56003011 The %A%-fixed %A% name %A%%A% has been truncated to fit the database.
56003012 More than one %A% of %A% %I% (internal id=%I%) from the import database have
been equivalenced with a common %A% from the current database. The import
operation cannot continue, since erroneous topology would result. The cause of this
error is the specification of too large a tolerance for geometric equivalencing on
import.
56003013 The current group, "%A%", is referenced by a superelement. Since all imported
entities will be added to this group this import cannot continue. Please change the
current group and try again.
56003014 CAD model name %A% already exists in the current database, but its data does not
match that from the import database. This import cannot continue.
56003015 Error creating material %A%. Constitutive model %I% not found in the current
database.
56003016 The length of the entity list you entered exceeds the 256 character limit.
57000017 %A%
57000018 %A%
57000019 %A%
57000020 %A%
57000021 %A%
57000022 %A%
57000023 %A%
57000024 %A%
57000025 %A%
58000000 PARAM
58000001 No Variables defined
58000002 Please select a variable to be modified
58000003 Please input the Variable Name
58000004 Please input the Configuration Name
58000005 Illegal Variable Name
58000006 Illegal Configuration Name
58000007 Please input the Default Value
58000008 Variable "%A%" already exists. Overwrite?
58000009 The variable "%A%" has not been defined
58000010 The configuration "%A%" has not been defined
58000011 The configuration variable "%A%" has not been defined
58000012 Variable "%A%" is referenced by Fields. Do you wish to try to delete any associated
fields?
58000013 Cannot delete Current Configuration "%A%"
58000014 Configuration Name already exists
58000015 Name cannot be modified since Variable "%A%" is referenced
58000016 Please input the Modified Value
58000017 Referencing Field "%A%" cannot be deleted because it is attached to a Load/BC,
Element Property, or Material. The Variable cannot therefore be deleted either
Chapter 11: Status Messages 2173
Introduction
58000018 Other Fields reference Variable "%A%". Do you wish to try to delete those fields
also?
58000019 The deletion of a Parameter will reset all the properties and loadsbcs. Do you want
to continue?
58000020 The Variable "%A%" is referenced by complex fields. The Variable is not deleted.
58000021 The Variable "%A%" in the design study "%A%" has invalid bounds. Bounds were
modified to the default values.
58000022 The property selected is defined as a field. The parameter may not be created.
58000023 The beam section or beam dimension must be selected.
58000024 The property set or property word must be selected.
58000025 The variable <%A%> cannot be modified in Create option. Use Modify option to
modify the value of the variable.
58000026 A vector component must be picked.
58001001 Cannot allocate memory
59000000 LAMMODEL
59000001 Laminate "%A%" is attached to at least one property set. Do you wish to delete
property set(s) also?
59000002 No Elements selected
59000003 No Property Set selected
59000004 No Laminates selected
59000005 No Layers selected
59000006 No Existing Properties selected
59000007 No Display Method selected
59000008 A Layup file must be open
59000009 Layup file "%A%" could not be opened
59000010 An error occurred during "%A%" creation
59000011 An error occurred during "%A%" showing
59000012 An error occurred during "%A%" deletion
59000013 An error occurred during index file creation
59000014 Cannot open the file "%A%"
59000015 Close existing Layup file
2174 PCL Reference Manual
Introduction
59000082 Unable to remove the SelectDatabox contents from the Split Definition Textbox.
59000083 Unable to add the SelectDatabox contents to the Split Definition Textbox.
59000084 Do you wish to delete all %I% instances of "%A%"?
59000085 No row selected in the spreadsheet
59000086 No existing material selected
59000087 Cannot use Paste until after a Copy or Cut
59000500 No start point selected. Please select one.
59000501 No end point selected. Please select one.
59000502 No interior points selected. Please select one or more.
59000503 No surface selected. Please select one.
59000504 Interior Point %I% is on an edge. Please select another point.
59000505 Start %A% does not lie on or near an edge. Please select another point.
59000506 End %A% does not lie on or near an edge. Please select another point.
59000600 No existing Ply selected
59000601 "%A%" to be created already exists
59000602 Existing Ply selection required
59000700 Layup report file "%A%" created
59100001 LammodelFailureCalculate: Undefined failure criterion: %A%
59100002 LammodelFailureCalculate: Warning: No selected area
59100003 LammodelFailureCalculate: Error: num_elems_max = %I%
59100004 LammodelFailureCalculate: Warning: Element %I% has no plies
59100005 Abnormal exit from the call: LammodelFailureCalculate:
LamFailCalcComputeMCF() for elem = %I%, ply = %I%. No results creation for the
whole model.
59100006 LamFailCalcComputeMCF: Error: Unsupported criterion_id = %I%
59100007 LamFailCalcTsaiwu: Error: In-plane strength values must be > 0.0
59100008 LamFailCalcTsaiwu : Error : Through-thickness strength values must be >= 0.0
59100009 LamFailCalcTsaiwu : Error : Failure interaction value must be -1.0 < F12 < 1.0
59100010 LamFailCalcTsaiwu : Error : Failure index cannot be calculated
59100011 LamFailCalcMaximum : Error : In-plane strength values must be > 0.0
59100012 LamFailCalcMaximum : Error : Through-thickness strength values must be >= 0.0
59100013 LamFailCalcHill : Error : In-plane strength values must be > 0.0
59100014 LamFailCalcHill : Error : Through-thickness strength values must be >= 0.0
59100015 LamFailCalcHill : Error : Failure index cannot be calculated
Chapter 11: Status Messages 2177
Introduction
60000000 DESIGNSTUDY
60000001 Unable to allocate the necessary memory.
60000002 Constraint %A% has an empty property set. Either delete the constraint or re-create
it with a valid property set.
60000003 The constraint region is empty. Make sure it has valid finite element entities.
60000004 Ply number %A% is invalid.
60000005 Frequency mode number is invalid.
60000006 Upper bound value %A% is invalid.
60000007 Lower bound value %A% is invalid.
60000008 Lower bound value is greater than upper bound value.
60000009 Constraint %A% references undefined element %I%. Please select valid element(s).
60000010 Constraint %A% references undefined node %I%. select valid node(s).
60000011 Design study name is blank. Please provide a design study study name.
60000012 Design Study %A% already exists. Do you want to overwrite it?
60000013 Constraint name is blank. Please provide a constraint name.
60000014 Constraint %A% already exists. Do you want to overwrite it?
60000015 Constraint %A% has an empty FEM region. Either delete the constraint or re-create
it with valid node(s).
60000016 Constraint %A% has an empty FEM region. Either delete the constraint or re-create
it with valid element(s).
60000017 The constraining region is empty. Make sure it has a valid property set(s).
60000018 The selected element(s) do not match the Constraint Region's element type, which is
%A%. Please select again.
60000019 Constraint region is invalid.
60000020 Constraint %A% references undefined element %I%. Make sure to select valid
element(s). There are more than one undefined element. Do you want to skip the rest
of messages?
60000021 Constraint %A% references undefined node %I%. Make sure to select valid node(s).
There are more than one undefined grid. Do you want to skip the the rest of messages?
60000022 A subcase must be selected for the optimization analysis. Please return to the Subcase
Select form and choose a subcase.
60000023 Thermal analysis is not currently supported for SOL 200 Optimization.
Chapter 11: Status Messages 2179
Introduction
60000024 *** WARNING: Out of %I% bound or limit modification(s) you tried, %I% is(are)
invalid and therefore aborted.
60000025 The current implementation of Design Optimization does not support a mixture of
solution sequences for the subcases. The translation is terminating.
60000026 A Design Study is not Defined. Do you wish to perform a multi-analysis run under
SOL 200?
60000027 No design constraints were defined in the current design study. The translation is
continuing without constraints.
60000028 No subcases have been found for the job. The translation is terminating.
60000029 The number of subcases exceeds the job limit. %I% subcases were requested but only
%I% were defined in the job.
60000030 The region associated with constraint %A% is empty.
60000031 Translating design variables.
60000032 Translating design constraints.
60000033 No design variables were defined in the current design study. The translation is
continuing.
60000034 **ERROR: Only one design variable per DVPREL1 is supported at this time.
60000035 A design study is required to run an optimization job. Please go to the Design Study
pick under the Tools menu to define a design study.
60000036 Your modification(s) of the design study value will cause the bound(s) to be invalid.
Would you like to use the default bound(s) based on your modification(s)?
60000037 Region %A% is empty. Translation is continuing without constraints associated with
this region.
60000038 Failed to get the number of parameters from the database.
60000039 Failed to get the parameter id's from the database.
60000040 Failed to get the parameter with id %I% from the database.
60000041 No id for design study "%A%" is found in the database.
60000042 No id for parameter "%A%" is found in the database.
60000043 Failed to create design variable "%A%" in the database for design study "%A%".
60000044 No design constraints defined for subcase "%A%".
60000045 Lower bound with zero value for a constraint is not recommended. Specify a non-zero
value or leave it blank if the constraint is for displacement magnitude or von Mises
stress/strain.
60000046 Upper bound with zero value for a constraint is not recommended.
2180 PCL Reference Manual
Introduction
SGM_RSM
This chapter lists all of the status conditions that are used to report the status of and errors from functions
that manipulate SGM.
61000000 SGM_RSM
61001001 SGM_RSM_INFO
61001002 SGM_RSM_LAST_INFO
61002001 SGM_RSM_WARNING
61002002 There are %I% inner loops in the selected surface mesh.
61002003 Duplicate vertices with node id %I% are found on the vertex list. Only one vertex
with node id %I% will be used.
61002004 The element edge defined by the nodes with ids %I% and %I% is short (length =
%F%). The resulting tessellated surface may have bad parameterization. If the
program fails to create a surface, edit the mesh and try again.
61002005 The triangle defined by the nodes with ids %I%, %I% and %I% is small (area =
%F%). The resulting tessellated surface may have bad parameterization. If the
program fails to create a surface, edit the mesh and try again.
61002006 SGM_RSM_LAST_WARNING
61003001 SGM_RSM_FATAL
61003002 No shell elements were selected. Select shell elements to create the surface.
61003003 Insufficient memory available. Close other applications and try again.
61003004 The selected mesh is invalid. Three or more elements in the mesh share the edge
with nodes %I% and %I%.
61003005 There are no free element edges in the selected mesh. The mesh should be an open
shell to create a surface.
61003006 The selected elements form 2 or more disconnected shell meshes. Merge the shell
meshes using finite Elements Modify-Mesh-Sew to one and try again or create a
surface for each shell mesh.
61003007 Failed on abort signal from client.
61003008 The selected mesh is invalid. Three or more elements in the mesh share edges. This
is occurring between elements using the following nodes: %A%
61003009 Error found in disassociating edges with trias.
61003010 The hole with node %I% could not be filled.
61003011 Error on editing the mesh on a hole.
61003012 The selected vertex (Node %I%) is not on the boundary. Select boundary nodes for
vertices and try again.
61003013 Duplicate edge with node ids %I% and %I% found on a boundary. Please edit the
mesh and try again.
Chapter 11: Status Messages 2181
Introduction
61003014 The boundary of the mesh intersects at the node %I%. Please edit the mesh and try
again.
61003015 The input mesh is connected in such a way that it corresponds to the topology of a
torus or other surface of higher genus. We are unable to create a surface mapping
for this situation. You should partition the input into simpler sets and create two or
more surfaces in place of the one just attempted.
61003016 The inner loop with node %I% could not be filled. Please check that inner loop and
see if there are some overlapped elements around that loop.
61003017 Error in selecting four default vertices. Please select 4 vertices on the outer loop of
the mesh and try again.
61003018 SGM_RSM_LAST_FATAL
61004001 SGM_RSM_CRASH
61004003 SGM_RSM_LAST_CRASH
2182 PCL Reference Manual
Introduction
MSC.Fatigue Quick Start Guide
Index
PCL Reference Manual
A asm_const_grid_interp_point_man, 524
add_plotset_row, 1606 asm_const_grid_intersect, 526
arbitrary_read_file, 1305 asm_const_grid_intersect_plo_cv, 527
arbitrary_section_create, 1306 asm_const_grid_intersect_plo_vc, 528
arbitrary_section_display, 1306 asm_const_grid_offset, 529
Index arbitrary_section_modify, 1308 asm_const_grid_pierce, 530
arbitrary_section_report, 1308 asm_const_grid_project_v1, 532
arbitrary_select_surface, 1310 asm_const_grid_xyz, 533
asm_const_coord_3point, 477 asm_const_hpat_2surface, 535
asm_const_coord_axis, 478 asm_const_hpat_3surface, 537
asm_const_coord_euler, 479 asm_const_hpat_4surface, 539
asm_const_coord_normal, 481 asm_const_hpat_face, 541
asm_const_coord_normal_v1, 483 asm_const_hpat_vertex, 542
asm_const_curve_2d_arc2point, 485 asm_const_hpat_xyz, 544
asm_const_curve_2d_arc3point, 487 asm_const_line_2point, 545
asm_const_curve_2d_circle, 489 asm_const_line_3point, 546
asm_const_curve_2d_circle_v2, 490 asm_const_line_4point, 547
asm_const_curve_arc3point, 492 asm_const_line_arc3point, 549
asm_const_curve_bspline, 494 asm_const_line_conic, 551
asm_const_curve_extract, 496 asm_const_line_extract, 552
asm_const_curve_extract_edge, 497 asm_const_line_fillet, 553
asm_const_curve_intersect, 499 asm_const_line_fit, 555
asm_const_curve_intersect_2pln, 502 asm_const_line_intersect, 556
asm_const_curve_intersect_plane, 501 asm_const_line_normal, 558
asm_const_curve_involute, 504 asm_const_line_project, 559
asm_const_curve_loft, 506 asm_const_line_project_v1, 561
asm_const_curve_manifold_2point, 508 asm_const_line_pwl, 562
asm_const_curve_manifold_npoint, 510 asm_const_line_spline, 563
asm_const_curve_project, 511 asm_const_line_tancurve, 565
asm_const_curve_revolve, 513 asm_const_line_tanpoint, 566
asm_const_grid_arccenter, 514 asm_const_line_xyz, 567
asm_const_grid_extract, 515 asm_const_patch_2curve, 568
asm_const_grid_extract_surf_par, 518 asm_const_patch_2curve_v1, 570
asm_const_grid_extract_surf_pts, 519 asm_const_patch_3curve, 571
asm_const_grid_extract_surface, 517 asm_const_patch_4curve, 572
asm_const_grid_extract_v1, 516 asm_const_patch_edge, 574
asm_const_grid_interp_curve, 521 asm_const_patch_extract, 575
asm_const_grid_interp_curve_v1, 522 asm_const_patch_fillet, 577
asm_const_grid_interp_point, 523 asm_const_patch_match, 579
asm_const_patch_vertex, 580
2184 PCL Reference Manual
C fem_conn_fastener_prop_modify, 1197
cline_section_create, 1323 fem_conn_fastener_verify, 1127
copy_plotset_row, 1611 fem_conn_property_create, 1009
create_freebody_fields3, 1059 fem_conn_property_get, 1197
curve_color, 1830 fem_conn_property_modify, 1199
curve_label, 1831 fem_conn_spotweld_create, 1010
fem_conn_spotweld_modify, 1199
fem_conn_spotweld_prop_create, 1011
D fem_conn_spotweld_prop_modify, 1201
db_get_connector_fastener, 1244
fem_conn_spotweld_verify, 1127
db_get_connector_spot_weld, 1245
fem_create_elems_1, 1012
db_get_connector_type, 1245
fem_create_mesh_2curve_1, 1022
db_get_load_case_id, 1383
fem_create_mesh_curv_1, 1024
db_get_load_case_title, 1382
fem_create_mesh_quad_4, 1035
db_get_primary_res_id, 1386
fem_create_mesh_sol_3, 1025
db_get_primary_res_label, 1385
fem_create_mesh_sol_5, 1027
db_get_secondary_res_id, 1388
fem_create_mesh_surf_3, 1030
db_get_secondary_res_label, 1387
fem_create_mesh_surf_4, 1033
db_get_sub_case_id, 1385
fem_create_mpc_cyclic_symmetry, 1015
db_get_sub_case_title, 1384
fem_create_mpc_nodal, 1017
db_update_mesh_params, 1389
fem_create_mpc_nodal2, 1019
del_2n_edge_for_all_elm, 1196
fem_create_mpc_sliding_surface, 1020
delete_plotset_row, 1612
fem_create_mshctl_surface.exec, 1041
delete_plotset_rows, 1612
fem_create_nodes_1, 1011
display_deformations, 1831
fem_create_surface_mesh_control, 1041
display_fa_vectors, 1832
fem_delete_conn_by_id, 1237
display_freebody_data3, 1193
fem_delete_elem_and_node, 1238
display_result_vectors, 1832
fem_delete_element, 1239
fem_delete_free_node, 1240
E fem_delete_mesh_from_curve, 1241
elementprops_compress, 1282 fem_delete_mesh_from_solid, 1243
elementprops_create, 1279 fem_delete_mesh_from_surface, 1242
elementprops_delete, 1282 fem_disassoc_geo, 1106
elementprops_expand, 1283 fem_disassoc_ids, 1107
elementprops_modify, 1285, 1288 fem_equiv_all_group, 1108
elementprops_show, 1291 fem_equiv_all_group2, 1110
exp_data_fitting.calculate, 1300 fem_equiv_all_group3, 1112
exp_data_fitting.get_coeffs, 1302 fem_equiv_list, 1114
exp_data_fitting.material_exists, 1304 fem_equiv_list_display.plot, 1118
exp_data_fitting.set_extra_props, 1304 fem_equiv_list2, 1115
exp_data_fitting.set_props, 1303 fem_equiv_list3, 1117
fem_equiv_preview, 1120
F fem_geom_edge_length, 1247
fem_conn_fastener_create, 1008 fem_geom_edge_length2, 1249
fem_conn_fastener_prop_create, 1009 fem_geom_elem_location, 1252
2186 PCL Reference Manual
xy_window_num_get, 1631
xy_window_post, 1632
xy_window_posted_get, 1633
xy_window_rename, 1746
xy_window_title_post, 1641
xy_window_title_unpost, 1642
xy_window_unpost, 1634
xy_write_curve_file.write_curve, 1634