Professional Documents
Culture Documents
June 2014
DSHIP-PE-200078I
Copyright
Copyright © 2004-2014 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.
Portions of this software are owned by Spatial Corp. © 1986-2014. All Rights Reserved.
Portions of the user interface copyright 2012-2014 Telerik AD.
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, FrameWorks, I-Sketch, SmartMarine, IntelliShip, ISOGEN, SmartSketch,
SPOOLGEN, SupportManager, SupportModeler, Sapphire, and Intergraph Smart are trademarks or registered trademarks of
Intergraph Corporation or its subsidiaries in the United States and other countries. Hexagon and the Hexagon logo are registered
trademarks of Hexagon AB or its subsidiaries. Microsoft and Windows are registered trademarks of Microsoft Corporation. ACIS is a
registered trademark of SPATIAL TECHNOLOGY, INC. Infragistics, Presentation Layer Framework, ActiveTreeView Ctrl,
ProtoViewCtl, ActiveThreed Ctrl, ActiveListBar Ctrl, ActiveSplitter, ActiveToolbars Ctrl, ActiveToolbars Plus Ctrl, and ProtoView are
trademarks of Infragistics, Inc. Incorporates portions of 2D DCM, 3D DCM, and HLM by Siemens Product Lifecycle Management
Software III (GB) Ltd. All rights reserved. Gigasoft is a registered trademark, and ProEssentials a trademark of Gigasoft, Inc.
VideoSoft and VXFlexGrid are either registered trademarks or trademarks of ComponentOne LLC 1991-2013, All rights reserved.
Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle Corporation and/or its affiliates. Tribon is a
trademark of AVEVA Group plc. Alma and act/cut are trademarks of the Alma company. Other brands and product names are
trademarks of their respective owners.
Regions....................................................................................................................................................... 33
Region Corrosion Sheet ........................................................................................................................ 33
Compartmentation Symbols..................................................................................................................... 35
Index ........................................................................................................................................................... 59
Documentation Set
Intergraph SmartTM 3D Documentation is available as Adobe PDF files. The content is the same
as the online Help. To access these PDF documents, click Help > Printable Guides in the
software.
The documentation set is divided into four categories:
Administrative guides contain information about installing, configuring, customizing, and
troubleshooting.
User's guides provide command reference and how-to information for working in each task.
Reference data guides define the reference data workbooks. Not all tasks have reference
data.
ISOGEN guides.
Administrative Guides
Intergraph SmartTM 3D Installation Guide - Provides instructions on installing and configuring the
software.
Project Management User's Guide - Provides instructions for setting up the databases, creating
permission groups, backing up and restoring project data, assigning access permissions to the
model, defining and managing locations for Global Workshare, and version upgrade.
Global Workshare Guide - Provides instructions for setting up the software and the databases to
work in a workshare environment.
Interference Checking Guide - Provides information on installing, configuring, and using the
interference detection service.
Integration Reference Guide - Provides information about installing, configuring, and using
Smart 3D in an integrated environment.
Interpreting Human Piping Specifications - Provides information about how to interpret human
piping specifications so that you can create the corresponding piping specification in the
software.
Design and Data Exchange with PDMS - Provides information about how to export model data
from Smart 3D to PDMS and from PDMS to Smart 3D. Specific guidelines relating to best
practices and known limitations of the export functionality are also included.
Export to Plant Design System (PDS) User's Guide - Provides information about how to export
model data from Smart 3D to PDS. Specific guidelines relating to best practices and known
limitations of the export functionality are also included.
Point Cloud Reference - Provides information for referencing point cloud files provided by point
cloud vendors in Smart 3D.
Troubleshooting Reference Guide - Provides information on how to resolve errors that you might
encounter in the software by documenting troubleshooting tips, error messages, and To Do List
messages.
Plant Design System (PDS) Guide - Provides all information needed to use PDS with Smart 3D.
Topics include referencing active PDS projects in Smart 3D, exporting PDS data and importing
that data into Smart 3D, and converting PDS reference data to Smart 3D reference data.
Intergraph SmartTM 3D Programmer's Guide - Provides information about custom commands,
naming rules, and symbol programming. If you install the Programming Resources, this
document is delivered to the [Product Folder]\Programming\Help folder.
User's Guides
Catalog User's Guide - Provides information about viewing, editing, and creating reference data
and select lists (codelists).
Civil User's Guide - Provides information about routing trench runs in the model.
Common User's Guide - Provides information about defining workspaces, manipulating views,
and running reports.
Compartmentation User's Guide - Provides instruction for placing volume objects such as
compartments and zones in the model.
Electrical User's Guide - Provides information about routing electrical cable, cableway, cable
tray, and conduit.
Equipment and Furnishings User's Guide - Provides information about placing equipment.
Geometry Analysis and Repair User's Guide - Provides instructions for importing and exporting
model data, checking the data against a defined set of requirements, and repairing the data.
Grids User's Guide - Provides instructions for creating coordinate systems, elevation grid
planes, vertical grid planes, radial cylinders, radial planes, grid arcs, and grid lines.
Hangers and Supports User's Guide - Provides instructions on placing piping, duct, and
cableway supports in the model.
Hole Management User's Guide - Provides instructions for placing, reviewing, and approving
holes in a structure.
HVAC User's Guide - Provides instructions for routing HVAC duct.
Molded Forms User's Guide - Provides instructions for placing hull, bulkheads, major openings,
stiffeners, and other major structural components in the model.
Orthographic Drawings User's Guide - Provides information about creating and managing
orthographic drawings.
Piping Isometric Drawings User's Guide - Provides information about creating and managing
piping isometric drawings.
Piping User's Guide - Provides instructions for routing pipe and placing valves, taps, and pipe
joints.
Planning User's Guide - Provides instructions about defining the assembly hierarchy (production
bill of material) by creating blocks and assemblies and by specifying the assembly sequence.
Reports User's Guide - Provides information about creating and managing spreadsheet reports.
Space Management User's Guide - Provides instructions for placing space objects such as
areas, zones, interference volumes, and drawing volumes in the model.
Structural Analysis User's Guide - Provides instructions for defining loads, load cases, load
combinations, and the importing and exporting of analytical data.
Structural Detailing User's Guide - Provides instructions for creating, detailing, and maintaining
the structural members of a model.
Structural Manufacturing User's Guide - Provides instructions for creating and maintaining
manufacturing objects such as templates, jigs, and margins.
Structure User's Guide - Provides instructions for placing structural members, such as beams,
columns, slabs, openings, stairs, ladders, equipment foundations, and handrails.
Systems and Specifications User's Guide - Provides instructions for creating systems and
selecting the available specifications for each system type.
Hole Management Reference Data Guide - Provides information about hole reference data.
HVAC Reference Data Guide - Provides information about HVAC reference data.
HVAC 3D Symbols Reference - Provides information about the HVAC 3D symbols that are
available.
Reference Data Guide - Provides instructions about the Bulkload utility, codelists, and the
reference data common to several disciplines.
Piping Reference Data Guide - Provides information about piping reference data including piping
specifications, piping specification rules, piping parts, and piping symbols.
Piping 3D Symbols Reference - Provides information about the piping 3D symbols that are
available.
Space Management Reference Data Guide - Provides information about space management
reference data.
Structure Reference Data Guide - Provides information about structural reference data.
Structure 3D Symbols Reference - Provides information about the stair, ladder, footings, and
equipment foundation 3D symbols that are available.
Structural Reference Data Overview - Provides an overview of the marine mode structural
reference data library.
ISOGEN Guides
Symbol Keys Reference Guide - Provides information about the symbol keys for isometric
drawings. This guide is from Alias, the makers of ISOGEN.
Documentation Comments
We welcome comments or suggestions about this documentation. You can send us an email at:
PPMdoc@intergraph.com.
Documentation updates for supported software versions are available from
https://smartsupport.intergraph.com (https://smartsupport.intergraph.com).
Compartmentation Workbooks
The Compartmentation reference data is defined in multiple workbooks, delivered to the
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles folder:
CompartGenericServices.xls
CompartLabels.xls
CompartmentCodeLists.xls
Compartments.xls
CompartReports.xls
InterferenceZoneCodeLists.xls
InterferenceZones.xls
RegionCodeLists.xls
Regions.xls
Compartmentation Symbols
Volumes in the Compartmentation task are not represented by 3D symbols, so you do not need
to be concerned with 3D symbol creation and definition.
However, the Compartmentation task does use 2D symbols in the Place Volume Along Path
command, when you specify a cross section. These symbols are defined in Visual Basic source
Compartmentation Rules
The Compartmentation rules are defined in Visual Basic source code, delivered to the
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules folder.
Compartment rules: CompartMergeSplitRule, CustomCompute, and Naming
General load rules: CustomCompute, Naming
General volume rules: CompartAttributeHelper, Naming
Load combination rules: Naming
Region rules: CustomCompute
Spatial load rules: FilterRule
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\InterferenceZones.xls
[Product
Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\InterferenceZoneCod
eLists.xls
Visual Basic Symbols: [Reference Data
Folder]\Compartmentation\Data\Symbols\Compartmentation\Shapes (Place Volume Along Path
command)
API: CompartQueryServices.dll, CompartAttributeHelper.dll
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\LoadCombination\Naming\LoadC
ombRules.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\SpatialLoad\FilterRule\SpatialFilte
r.vbp
Bulkload Workbook: [Product
Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\Compartments.xls
API: CompartQueryServices.dll, CompartAttributeHelper.dll
You can create hierarchy folders as needed under the Custom Symbols folder.
If a custom DLL has a localizer DLL, both files should be located in the same folder.
DLLs ending with "–Ref.dll" or "_Ref.dll" are treated as reference DLLs and are ignored.
These DLLs do not need to be copied from the client machine containing the rules
Visual Basic source code.
3. In the Project Management task, select a catalog that uses the SharedContent folder in
which your custom DLLs are located.
4. Click Tools > Update Custom Symbol Configuration, or right-click the catalog node, and
select Update Custom Symbol Configuration.
The Update Custom Symbol Configuration dialog box displays.
Update Custom Symbol Configuration creates or updates the
CustomSymbolConfig.xml file in the [Reference Data Folder]\SharedContent\Xml folder.
CustomSymbolConfig.xml contains entries with the ProgID, CLSID, and DLL name for each
class in the custom DLLs. After CustomSymbolConfig.xml is created, the software uses the
custom DLLs from the [Reference Data Folder]\SharedContent\Custom Symbols folder
without needing to register the DLL on the local computer.
5. Click OK to begin processing.
After you click OK, the options and commands on the dialog box are unavailable. This is to
prevent you from interrupting the update process. The status bar at the bottom of the dialog
box displays a message that the software is updating the symbol mapping file. When
processing completes, the status bar shows whether the process finished with or without
errors.
6. Click View log files to open the log file in your default text editor, and review the results.
uomValue As Double
End Type
Should be changed to:
Private Type InputType
Name As String
Description As String
Properties As IMSDescriptionProperties
uomValue As Double
End Type
Debugging and maintaining Visual Basic project references, reference DLLs, and binary
compatibility are beyond the scope of this document. Contact your Intergraph Support
representative if you have questions.
BulkCargoType
Defines bulk cargo types.
The Head section contains the following parameters (listed in alphabetical order):
actual_angle_of_repose - Actual angle subtended with the horizontal by the upper surface
of the conic pile, made by the cargo type when loaded into a hold.
BreadthofHatch - Inside breadth of the hatch.
Custom Program - Custom program for the cargo type, if needed. The Visual Basic source
code for the load custom programs (rules) is delivered in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomComput
e.
CmpartZoneCPS
The Head section contains the following parameters (listed in alphabetical order):
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
PartDescription - Part description.
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are
delivered to the [Reference Data Product Folder]\SharedContent folder.
CmpartZoneDamageControl
Defines ship zones for damage control.
The Head section contains the following parameters (listed in alphabetical order):
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
PartDescription - Part description.
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are
delivered to the [Reference Data]\SharedContent folder.
CmpartZoneFire
Defines ship fire zones.
The Head section contains the following parameters (listed in alphabetical order):
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
PartDescription - Part description.
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
RiskFactor - Risk factor associated with the part.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are
delivered to the [Reference Data Product Folder]\SharedContent folder.
CmpartZonePlanning
Defines ship zones for planning.
The Head section contains the following parameters:
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
PartDescription - Part description.
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are
delivered to the [Reference Data Product Folder]\SharedContent folder.
Classification - Classification for the part.
CompartmentCargo
Defines various cargo compartments.
The Head section contains the following parameters (listed in alphabetical order):
CompartmentGroup - Groups available for compartments.
CompartmentNumber - Manufacturers and model numbers for compartments.
CompartmentType - Types of compartments.
functionType - Types of functions for compartments.
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
PartDescription - Part description.
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
RelevantCargos - Cargo types available for compartments.
structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.
CompartmentHabitable
Defines living space compartments.
The Head section contains the following parameters (listed in alphabetical order):
CompartmentGroup - Groups available for compartments.
CompartmentNumber - Manufacturers and model numbers for compartments.
CompartmentType - Types of compartments.
functionType - Types of functions for compartments.
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
PartDescription - Part description.
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
RelevantCargos - Cargo types available for compartments.
structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.
CompartmentMachinery
Defines compartments for machinery.
The Head section contains the following parameters (listed in alphabetical order):
CompartmentGroup - Groups available for compartments.
CompartmentNumber - Manufacturers and model numbers for compartments.
CompartmentType - Types of compartments.
functionType - Types of functions for compartments.
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
PartDescription - Part description.
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
RelevantCargos - Cargo types available for compartments.
structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.
CompartmentTank
Defines compartment tank specifications.
The Head section contains the following parameters (listed in alphabetical order):
CompartmentGroup - Groups available for compartments.
CompartmentNumber - Manufacturers and model numbers for compartments.
CompartmentType - Types of compartments.
functionType - Types of functions for compartments.
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
PartDescription - Part description.
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
RelevantCargos - Cargo types available for compartments.
structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.
CompartmentUnknown
The Head section contains the following parameters (listed in alphabetical order):
CompartmentGroup - Groups available for compartments.
CompartmentNumber - Manufacturers and model numbers for compartments.
CompartmentType - Types of compartments.
functionType - Types of functions for compartments.
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
PartDescription - Part description.
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
RelevantCargos - Cargo types available for compartments.
structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.
CompartmentVoid
The Head section contains the following parameters (listed in alphabetical order):
CompartmentGroup - Groups available for compartments.
CompartmentNumber - Manufacturers and model numbers for compartments.
CompartmentType - Types of compartments.
functionType - Types of functions for compartments.
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
PartDescription - Part description.
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
RelevantCargos - Cargo types available for compartments.
structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.
GaseousCargoType
Defines cargo types for gases.
The Head section contains the following parameters (listed in alphabetical order):
Custom Program - Custom program for the cargo type, if needed. The Visual Basic source
code for the load custom programs (rules) is delivered in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomComput
e folder.
density - Thickness of a material (mass per unit volume).
Description - Part description.
LiquidCargoType
Defines cargo types for liquids.
The Head section contains the following parameters (listed in alphabetical order):
Custom Program - Custom program for the cargo type, if needed. The Visual Basic source
code for the load custom programs (rules) is delivered in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomComput
e folder.
density - Thickness of a material (mass per unit volume).
Description - Part description.
expansion_coefficient - Measurement of swelling or expansion of a composite material
due to temperature changes or moisture absorption.
FreeSurfaceCenter - Free surface center.
Name - Part name as displayed in the Catalog task. This identification must be unique
across the entire catalog.
OverPressure - Overpressure setting. Min according to rule.
required_carriage_pressure - Required pressure to keep the gas in a liquid state.
SloshingBreadth - Rule dependent definition.
SloshingLength - Rule dependent definition.
specific_heat_capacity - Amount of energy required to raise the temperature of a kilogram
of a material by 1 degree Centigrade.
TankHoldNumber – Tank Hold number. Tank number starts in the forship: Fore tank: 1->.
thermal_conductivity - Rate at which a material conducts heat.
TopOfAirPipe - Top of air pipe.
viscosity - Measured resistance to flow.
LoadCaseType
Defines the type of cargo load.
The Head section contains the following parameters (listed in alphabetical order):
Description - Part description.
LiquidPressure - Fluid pressure per unit area.
Name - Part name as displayed in the Catalog task. This identification must be unique
across the entire catalog.
SeaPressure - Pressure at sea level.
UnitCargoType
The Head section contains the following parameters (listed in alphabetical order):
Custom Program - Custom program for the cargo type, if needed. The Visual Basic source
code for the load custom programs (rules) is delivered in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomComput
e folder.
Description - Part description.
Name - Part name as displayed in the Catalog task. This identification must be unique
across the entire catalog.
permeability - Measure of how easily fluid (e.g., water) can pass through a porous medium.
stack_limit - Maximum number of this type of material that can be stacked on top of each
other.
stowage_factor - Ratio of weight to stowage space required under normal conditions.
volume - Volume of compartment.
weight - Weight of the compartment.
VoidSpace
Defines volumes set aside for space reservation in a model.
The Head section contains the following parameters (listed in alphabetical order):
MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
PartDescription - Part description.
PartNumber - Part number or name as displayed in the Catalog task. This identification
must be unique across the entire catalog.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are
delivered to the [Reference Data Folder]\SharedContent folder.
Common Properties
These properties appear for the load case and cargo type classes. The properties are listed
here in the order that they appear, from left to right, on the part sheet.
Name - Type the unique identification for the part as found in the catalog data.
Description - Type a description for the part.
Unique Properties
Unique properties appear only for certain classes.
Custom Program - Type a custom program for the cargo type, if necessary. The Visual Basic
source code for the load custom programs (rules) is delivered in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomCompute
folder.
See Also
Compartmentation Part Classes and Load Case Types (on page 21)
CompartmentCargoRule
Defines the load on a compartment based on the type of cargo the compartment is holding.
The Head section contains the following parameters (listed in alphabetical order):
CompartmentObject - Type of compartment object, such as a CompartmentTank.
LoadType - Type of load, such as a GaseousCargoType.
RuleName - Rule name as displayed in the Catalog task.
Interference Zones
The InterferenceZones.xls workbook defines the zones available for interferences in the
model. These zones are similar to interference volumes, but include the ability to construct ACIS
geometry. An example of when to use an interference zone is when you want an evacuation
path that must remain clear.
See Also
Compartmentation Reference Data (on page 13)
Understanding the Compartmentation Reference Data Workflow (on page 14)
What's New in Compartmentation Reference Data (on page 12)
Interference Zone Type Sheet (on page 31)
Regions
The Regions.xls workbook defines the regions that are available for placement in the model.
These regions support custom analysis rules that can be used to apply corrosion factors or other
rules during data extraction for analysis.
See Also
Compartmentation Reference Data (on page 13)
Understanding the Compartmentation Reference Data Workflow (on page 14)
What's New in Compartmentation Reference Data (on page 12)
Region Corrosion Sheet (on page 33)
Compartmentation Symbols
Compartment volumes, ship zones, interference zones, and regions are not represented by 3D
symbols, so you do not need to be concerned with 3D symbol creation and definition.
However, the Compartmentation task does use 2D symbols in the Place Volume Along Path
command, when you specify a cross section. These symbols are defined in Visual Basic source
code, delivered to the [Reference Data Product
Folder]\Compartmentation\Data\Symbols\Compartmentation\Shapes folder. The files in this
folder are not used by Compartmentation. This project is for reference and can be used for
customization purposes.
Delivered symbols include a circle, hexagon, oval, square, and so forth. Bitmaps are provided
on the Symbols share, in the SketchCrossSections folder.
Symbol Picture
Circle
Rectangle
Triangle
Ellipse
Hexagon
Sector
Road
TrapezoidC (concentric)
I-Beam
See Also
Compartmentation Reference Data (on page 13)
Understanding the Compartmentation Reference Data Workflow (on page 14)
What's New in Compartmentation Reference Data (on page 12)
Naming Rules
The software provides several options for naming various types of compartmentation objects
that you can place in the model. In addition to the delivered sample naming rules that are
described below, you can create your own naming rules.
Part Description Rule - Names the object using the format:
[part description]-[global workshare location ID]-[index number]
The part description is the description from the SM3D reference data catalog for the
selected object. The global workshare location ID is the number assigned in the Project
Management task; and the index number is the object placement count. For example, the
name Wing tank-1-0001 represents the first object placed in the model at location 1.
Frame Rule - Names the objected based on the existing frame system within the site area.
From the frame system, the software checks the existing frame which is closest to the
compartment surface.
Space Rule - Names the object using the format:
[space folder name]-[global workshare location ID]-[index number]
The space folder name is the name of the currently-defined space folder you are using. The
global workshare location ID is the number assigned in the Project Management task, and the
index number is the object placement count. For example, the name Ship-1-0003 represents the
third object placed in the model in the Ship space folder at location 1.
Part Class Rule - Names the object using the format:
[part class name]-[global workshare location ID]-[index number]
The part class name is the class or type from the SM3D reference data catalog containing the
selected object. The global workshare location ID is the number assigned in the Project
Management task; and the index number is the object placement count. For example, the name
ShipZoneClass-1-0001 represents the first Ship Zone class object placed in the model at
location 1. Compartmentation contains the Compartments, Interference Zones, Regions, Ship
Zone and Void Space classes.
User Defined - Enables you to define the name of the compartment. After selecting this naming
rule, type the name in the Name box of the Properties dialog box.
Labels
The CompartLabels.xls workbook (Report sheet) lists the catalog labels that are available for
compartments. For example, the delivered labels show general information on a compartment,
tightness of a compartment, and the load on a compartment. The following table describes the
delivered labels.
Label Description
You can associate objects and labels, and you can edit labels by clicking Tools > Options and
selecting the ToolTips tab. To view a label in the software, you pause the mouse pointer over
the compartment in the model.
Reports
The CompartReports.xls workbook (Report sheet) lists the catalog reports that are available
for compartments. The delivered reports show compartment attributes, loads, objects inside the
compartments, and so forth. The following table describes the delivered reports.
Report Description
Report Description
If you do not select compartments before
running the report, all compartments in the current
work session are processed.
The underlying report processes include:
Get all the objects which are in touch with each
compartment.
Get the subtracted geometry of the compartment
and object.
Get the surface area of the subtracted geometry.
Get the coating information of the
compartment(s).
Compartment Weight and Displays a list of compartments, their weight and their
CG center of gravity.
Spatial Loads And Relations Displays a list of spatial loads, with associated load
Report combinations, compartments, and part descriptions.
This report provides a spatial load overview.
Unit Attributes Report Displays a list of unit loads, including their load
magnitudes and vector components.
Unit Loads And Relations Displays a list of unit loads and their parent folders.
Report This report provides a unit load overview.
Report Description
Volumes and Parents Report Displays a list of volumes in the model, with part
descriptions and parent folders.
To run a report, start the software, and click Tools > Run Report. Select the Catalog Reports
tab, and browse to the Compartmentation folder.
For more information about labels and reports, see the Common User's Guide and the Reports
User's Guide.
See Also
Compartmentation Reference Data (on page 13)
Understanding the Compartmentation Reference Data Workflow (on page 14)
What's New in Compartmentation Reference Data (on page 12)
Compartmentation Codelists
The CompartmentCodeLists.xls workbook specifies the compartmentation-specific codelists in
your catalog. Most of the codelists are examples and are not required in the catalog.
For more information about codelists, see the Smart 3D Reference Data Guide, available from
the Help > Printable Guides command.
See Also
Compartmentation Reference Data (on page 13)
Understanding the Compartmentation Reference Data Workflow (on page 14)
What's New in Compartmentation Reference Data (on page 12)
In This Section
Compart Coating Color Codelist .................................................... 48
Compart Coating Process Codelist ............................................... 48
Compart Coating Responsibility Codelist ...................................... 48
Compart Coating Status Codelist .................................................. 48
Compart Coating Type Codelist..................................................... 48
Compartment Authorization Class Codelist ................................... 48
Compartment Bulk Cargo Type Codelist ....................................... 48
Compartment Bulkhead Tightness Codelist .................................. 49
Compartment Capacity Context Codelist ...................................... 49
Compartment Cargo Context Codelist ........................................... 49
Compartment Coating Applicability Codelist ................................. 49
Compartment Coating Certification Codelist ................................. 49
Compartment Coating Inspection Codelist .................................... 49
Compartment Compartment Group Codelist ................................. 49
Compartment Compartment Type Codelist ................................... 49
Compartment Contact Material Type Codelist ............................... 50
Compartment Damage Location Codelist ...................................... 50
Compartment Damage Type Codelist ........................................... 50
Compartment Design Requirement Codelist ................................. 50
Compartment Function Type Codelist ........................................... 50
Compartment Insulation Category Codelist ................................... 50
Compartment Naval Nuclear Class Codelist ................................. 50
Compartment Naval Safety Category Codelist .............................. 50
Compartment Naval Security Class Codelist ................................. 51
Compartment Noise Category Codelist ......................................... 51
Compartment Positional Rel Type Codelist ................................... 51
Compartment Property Context Codelist ....................................... 51
Compartment Relevant Cargos Codelist ....................................... 51
Compartment Structure Type Codelist .......................................... 51
Compartment Surface Preparation Codelist .................................. 51
Load Case Liquid Pressure Codelist ............................................. 51
Load Case Sea Pressure Codelist ................................................ 52
Ship Design Loading Condition Type Codelist .............................. 52
Space Access Type Codelist ......................................................... 52
Space Adjacency Contact Type Codelist ...................................... 52
Regions Codelists
The RegionCodeLists.xls workbook specifies the regions- specific codelists in your catalog.
For more information about codelists, see the Smart 3D Reference Data Guide, available from
the Help > Printable Guides command.
See Also
Compartmentation Reference Data (on page 13)
Understanding the Compartmentation Reference Data Workflow (on page 14)
What's New in Compartmentation Reference Data (on page 12)
N
Naming Rules • 42
Naming Rules Sheet • 41
P
Preface • 9
R
Region Corrosion Sheet • 33
Region Ship Type Codelist • 57
Region Type Codelist • 57
Regions • 33
Regions Codelists • 57
S
Ship Design Loading Condition Type
Codelist • 52
Smart 3D and Oracle • 12
Space Access Type Codelist • 52
Space Adjacency Contact Type Codelist •
52
Space Adjacency Geometry Type Codelist •
52
Space Arrangement Orientation Codelist •
52
Space Arrangement Type Codelist • 52
Space Item Purpose Codelist • 52
Space Physical Orientation Type Codelist •
53
Space Positional Relationship Type
Codelist • 53
Space Product Structure Type Codelist • 53