Sei sulla pagina 1di 64

Compartmentation

Reference Data Guide

Version 2011 R1 (9.1)


May 2012
DSHIP-PE-200078G

Copyright
Copyright 2004-2012 Intergraph Corporation. All Rights Reserved.
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-2010. All Rights Reserved.

U.S. Government Restricted Rights Legend


Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of
the United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813

Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this 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. 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.

Warranties and Liabilities


All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software
or applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this
document or its contents shall be considered or deemed a modification or amendment of such warranties. 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 discussed in this document is furnished under a license and may be used or copied only in accordance with the
terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not
supplied by Intergraph or its affiliated companies. 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.

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, FrameWorks, I-Convert, I-Export, I-Sketch, SmartMarine, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks
of Intergraph Corporation or its subsidiaries in the United States and other countries. 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-2009, 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.

Contents
Preface .......................................................................................................................................................... 7
SmartMarine 3D Documentation Set ...................................................................................................... 9
Documentation Comments ................................................................................................................... 13
SmartMarine 3D and Oracle ................................................................................................................. 15
What's New in Compartmentation Reference Data ................................................................................ 17
Compartmentation Reference Data ......................................................................................................... 19
Understanding the Compartmentation Reference Data Workflow........................................................ 20
Compartmentation Reference Data Common Tasks ..................................................................... 23
Move Custom DLLs to SharedContent Folder ............................................................................... 23
Compartmentation Part Classes and Load Case Types ........................................................................ 27
Compartmentation Part Classes ........................................................................................................... 27
BulkCargoType ............................................................................................................................... 27
CmpartZoneCPS ............................................................................................................................ 28
CmpartZoneDamageControl .......................................................................................................... 28
CmpartZoneFire ............................................................................................................................. 28
CmpartZonePlanning...................................................................................................................... 29
CompartmentCargo ........................................................................................................................ 29
CompartmentHabitable................................................................................................................... 29
CompartmentMachinery ................................................................................................................. 30
CompartmentTank .......................................................................................................................... 30
CompartmentUnknown ................................................................................................................... 31
CompartmentVoid........................................................................................................................... 31
GaseousCargoType ....................................................................................................................... 31
LiquidCargoType ............................................................................................................................ 32
LoadCaseType ............................................................................................................................... 32
UnitCargoType ............................................................................................................................... 33
VoidSpace ...................................................................................................................................... 33
Compartmentation Load Case and Cargo Types ................................................................................. 33
Compartmentation Cargo Rules ........................................................................................................... 34
CompartmentCargoRule................................................................................................................. 34
Interference Zones .................................................................................................................................... 37
Interference Zone Type Sheet .............................................................................................................. 37
Regions....................................................................................................................................................... 39
Region Corrosion Sheet ........................................................................................................................ 39
Compartmentation Symbols..................................................................................................................... 41
Compartmentation Generic Services ...................................................................................................... 45
Compart Split Rule Sheet ..................................................................................................................... 45
Compartment Custom Attribute Sheet .................................................................................................. 46

Compartmentation Reference Data Guide

Contents
Custom Class Interface List Sheet........................................................................................................ 46
Naming Rules Sheet ............................................................................................................................. 47
Naming Rules ................................................................................................................................. 47
Compartmentation Labels and Reports .................................................................................................. 49
Compartmentation Codelists ................................................................................................................... 51
Compart Coating Color Codelist ........................................................................................................... 53
Compart Coating Process Codelist ....................................................................................................... 53
Compart Coating Responsibility Codelist ............................................................................................. 53
Compart Coating Status Codelist.......................................................................................................... 53
Compart Coating Type Codelist ............................................................................................................ 53
Compartment Authorization Class Codelist .......................................................................................... 53
Compartment Bulk Cargo Type Codelist .............................................................................................. 53
Compartment Bulkhead Tightness Codelist ......................................................................................... 53
Compartment Capacity Context Codelist .............................................................................................. 53
Compartment Cargo Context Codelist .................................................................................................. 54
Compartment Coating Applicability Codelist ......................................................................................... 54
Compartment Coating Certification Codelist ......................................................................................... 54
Compartment Coating Inspection Codelist ........................................................................................... 54
Compartment Compartment Group Codelist ........................................................................................ 54
Compartment Compartment Type Codelist .......................................................................................... 54
Compartment Contact Material Type Codelist ...................................................................................... 54
Compartment Damage Location Codelist ............................................................................................. 54
Compartment Damage Type Codelist .................................................................................................. 54
Compartment Design Requirement Codelist ........................................................................................ 55
Compartment Function Type Codelist .................................................................................................. 55
Compartment Insulation Category Codelist .......................................................................................... 55
Compartment Naval Nuclear Class Codelist ........................................................................................ 55
Compartment Naval Safety Category Codelist ..................................................................................... 55
Compartment Naval Security Class Codelist ........................................................................................ 55
Compartment Noise Category Codelist ................................................................................................ 55
Compartment Positional Rel Type Codelist .......................................................................................... 55
Compartment Property Context Codelist .............................................................................................. 55
Compartment Relevant Cargos Codelist .............................................................................................. 56
Compartment Structure Type Codelist ................................................................................................. 56
Compartment Surface Preparation Codelist ......................................................................................... 56
Load Case Liquid Pressure Codelist..................................................................................................... 56
Load Case Sea Pressure Codelist ........................................................................................................ 56
Ship Design Loading Condition Type Codelist ..................................................................................... 56
Space Access Type Codelist ................................................................................................................ 56
Space Adjacency Contact Type Codelist .............................................................................................. 56
Space Adjacency Geometry Type Codelist .......................................................................................... 56
Space Arrangement Orientation Codelist ............................................................................................. 57
Space Arrangement Type Codelist ....................................................................................................... 57
Space Item Purpose Codelist ............................................................................................................... 57
Space Physical Orientation Type Codelist ............................................................................................ 57
Space Positional Relationship Type Codelist ....................................................................................... 57
Space Product Structure Type Codelist ................................................................................................ 57
Interference Zones Codelists ................................................................................................................... 59
Interference Type Codelist .................................................................................................................... 59

Compartmentation Reference Data Guide

Contents
Regions Codelists ..................................................................................................................................... 61
Region Ship Type Codelist ................................................................................................................... 61
Region Type Codelist ............................................................................................................................ 61
Index ........................................................................................................................................................... 63

Compartmentation Reference Data Guide

Contents

Compartmentation Reference Data Guide

Preface
This document is a reference data guide for the SmartMarine 3D Compartmentation task. The
purpose of this document is to describe the reference data delivered with the software for this
task.
Reference data includes both catalog data and specification data. Catalog data includes the
parts that you place in the model, such as piping components and equipment. Specification data
includes the rules that govern how those parts are placed and connected.

Compartmentation Reference Data Guide

Preface

Compartmentation Reference Data Guide

SmartMarine 3D Documentation Set


SmartMarine 3D documentation is available as Adobe PDF files. The content is the same as
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 SmartMarine 3D.
User's guides provide command reference and how-to information for working in each
SmartMarine 3D task.
Reference data guides define the reference data workbooks. Not all tasks have reference
data.
ISOGEN guides

Administrative Guides
SmartMarine 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 migration.
SmartMarine 3D Global Workshare Guide - Provides instructions for setting up the software and
the databases to work in a workshare environment.
SmartMarine 3D Interference Checking Guide - Provides information on installing, configuring,
and using the interference detection service.
SmartMarine 3D Integration Reference Guide - Provides information about installing,
configuring, and using SmartMarine 3D in an integrated environment.
SmartMarine 3D 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.
SmartMarine 3D Export to PDMS - Provides information about how to export model data from
SmartMarine 3D to PDMS. Specific guidelines relating to best practices and known limitations of
the export functionality are also included.
SmartMarine 3D Point Cloud Reference - Provides information for referencing point cloud files
provided by point cloud vendors in SmartMarine 3D.
SmartMarine 3D Troubleshooting Guide - Provides information on how to resolve errors that you
may encounter in the software by documenting troubleshooting tips, error messages, and To Do
List messages.
SmartMarine 3D Plant Design System (PDS) Guide - Provides all information needed to use
PDS with SmartMarine 3D. Topics include referencing active PDS projects in SmartMarine 3D,
exporting PDS data and importing that data into SmartMarine 3D, and converting PDS reference
data to SmartMarine 3D reference data.
SmartPlant 3D/SmartMarine 3D Programmer's Guide - Provides information about custom
commands, naming rules, and symbol programming. This document is delivered, if you install
the Programming Resources, to the [Product Folder]\3D\Programming\Help folder.

User's Guides
Catalog User's Guide - Provides information about viewing, editing, and creating reference data
and select lists (codelists).

Compartmentation Reference Data Guide

Preface
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 components of a ship's frame 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, 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 Ship.
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 which specifications are available for each system type.

Reference Data Guides


SmartMarine 3D 2D Symbols User's Guide - Provides command reference information and
procedural instructions for creating 2D symbols used to represent collars, clips, profiles,
brackets, and other items.
SmartMarine 3D 2D Symbols Reference Data Guide - Provides information about the
two-dimensional symbols used in all tasks.

10

Compartmentation Reference Data Guide

Preface
Compartmentation Reference Data Guide - Provides information about compartmentation
reference data.
Drawings and Reports Reference Data Guide - Provides information about reports reference
data.
Electrical Reference Data Guide - Provides information about electrical cable, cableway, cable
tray, and conduit reference data.
Electrical 3D Symbols Reference - Provides information about the cable tray and conduit 3D
symbols that are available.
Equipment and Furnishings Reference Data Guide - Provides information about equipment
reference data.
Equipment 3D Symbols Reference - Provides information about the equipment, equipment
component, design shapes, and design aides 3D symbols that are available.
Hangers and Supports Reference Data Guide - Provides information about hangers and
supports reference data.
Hangers and Supports 3D Symbols Reference - Provides information about the hanger and
support 3D symbols that are available.
Hangers and Supports SmartPart Symbols Reference - Provides information about the hanger
and support SmartPart symbols that are available.
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.
SmartMarine 3D 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.
SmartMarine 3D Structural Reference Data Overview - Provides an overview of the
SmartMarine 3D 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.

Compartmentation Reference Data Guide

11

Preface

12

Compartmentation Reference Data Guide

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 eCustomer
https://crmweb.intergraph.com.

Compartmentation Reference Data Guide

13

Preface

14

Compartmentation Reference Data Guide

SmartMarine 3D and Oracle


SmartMarine 3D shares much of its functionality with Intergraph's plant design software,
SmartPlant 3D. Because of this shared functionality, you will see throughout the software
references and options pertaining to Oracle databases, which SmartPlant 3D supports but
SmartMarine 3D does not. Please remember that when using SmartMarine 3D, to always select
the SQL option when given a choice between Oracle and SQL.

Compartmentation Reference Data Guide

15

Preface

16

Compartmentation Reference Data Guide

What's New in Compartmentation


Reference Data
The following changes have been made to the Compartmentation reference data.
Version 2011 R1 (9.1)
No changes were made to this document for this release.

Compartmentation Reference Data Guide

17

What's New in Compartmentation Reference Data

18

Compartmentation Reference Data Guide

SECTION 1

Compartmentation Reference Data


Each organization using the software requires customized reference data such as rules, catalog
items, and symbols to meet their exact needs. Customized rules control how and when the
catalog items and symbols are used in the model.
Before working with compartmentation reference data, you must be familiar with how the
software handles reference data in general. If you have not already done so, read and
understand the following important concepts and procedures described in the SmartMarine 3D
Reference Data Guide and SmartMarine 3D Symbols Reference Data Guide:
Bulkloading
Excel reference data workbooks
Custom interfaces and attributes
Naming rules and other types of rules
Symbols
Codelists (also referred to as "select lists")
This reference data guide describes the example compartmentation reference data delivered
with the software. Microsoft Excel workbooks are delivered for bulkloading items into the
Catalog. Visual Basic source code files are delivered for the rules.

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
code, delivered to the [Reference Data
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.
For more information about symbols, see the Equipment 3D Symbols Reference and
SmartMarine 3D 2D Symbols Reference Data Guide.

Compartmentation Reference Data Guide

19

Compartmentation Reference Data


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

Compartmentation Application Programming Interface


An application programming interface (API), CompartQueryServices.dll, is provided in the
software for common objects, methods, and properties used in the Compartmentation query
service custom command. For more information, see the Compartmentation Query Services
Customization documentation, which also describes the Compartmentation Attribute Helper and
Compartmentation Geometry Service Object. This documentation is available as part of the
programming reference documentation.

See Also
Compartmentation Part Classes and Load Case Types (on page 27)
Compartmentation Generic Services (on page 45)
Compartmentation Codelists (on page 51)

Understanding the Compartmentation Reference Data


Workflow
The reference data for the Compartmentation task is divided into the following areas:
Catalog parts, such as compartments, ship zones, load cases, cargo types, interference
zones, regions, and so forth.
Rules for custom calculations and for naming.
Custom interfaces and attributes.
Labels and reports for compartments and loads.
Codelists, which define attribute values.
Each type of reference data for the Compartmentation task has a different set of related
reference data files:

Creates and names compartments in the model


Visual Basic Rules:
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplit
Rule\CompartMergeSpltRule.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\C
ompartSemantics.vbp (6 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming\Compartm
entNamingRules.vbp

20

Compartmentation Reference Data Guide

Compartmentation Reference Data


[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\CompartAttribute
Helper\CompartHelper.vbp (4 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\Naming\Compart
Rules.vbp (3 classes)
Bulkload Workbook: [Product
Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\Compartments.xls,
CompartmentCodeLists.xls
Visual Basic Symbols: [Reference Data
Folder]\Compartmentation\Data\Symbols\Compartmentation\Shapes (Place Volume Along Path
command)
API: CompartQueryServices.dll, CompartAttributeHelper.dll

Creates and names interference zones in the model


Visual Basic Rules:
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplit
Rule\CompartMergeSpltRule.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\C
ompartSemantics.vbp (6 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming\Compartm
entNamingRules.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\CompartAttribute
Helper\CompartHelper.vbp (4 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\Naming\Compart
Rules.vbp (3 classes)
Bulkload Workbook:
[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

Creates and names regions in the model


Visual Basic Rules:
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplit
Rule\CompartMergeSpltRule.vbp

Compartmentation Reference Data Guide

21

Compartmentation Reference Data


[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\C
ompartSemantics.vbp (6 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming\Compartm
entNamingRules.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\CompartAttribute
Helper\CompartHelper.vbp (4 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\Naming\Compart
Rules.vbp (3 classes)
Bulkload Workbook: [Product
Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\Regions.xls,
RegionCodeLists.xls
Visual Basic Symbols: [Reference Data
Folder]\Compartmentation\Data\Symbols\Compartmentation\Shapes (Place Volume Along Path
command)
API: CompartQueryServices.dll, CompartAttributeHelper.dll

Creates and names loads and load combinations in the model


Visual Basic Rules:
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomCompute\C
ustomLoad.vbp (2 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\Naming\LoadNamin
gRules.vbp (2 classes)
[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

Defines codelist values used by Compartmentation


Bulkload Workbook: [Product
Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\CompartmentCodeLi
sts.xls, InterferenceZoneCodeLists.xls, RegionCodeLists.xls

See Also
Compartmentation Reference Data Common Tasks (on page 23)

22

Compartmentation Reference Data Guide

Compartmentation Reference Data

Compartmentation Reference Data Common Tasks


By following these tasks, you can create and customize your own compartmentation reference
data.

Define Compartmentation Part Classes


In addition to the compartment classes that are delivered with the software, you can add classes
to the catalog. For more information, see Compartmentation Part Classes (on page 27).

Define Compartmentation Load Case Types and Cargo Types


In addition to the load case and cargo types that are delivered with the software, you can add
types to the catalog. For more information, see Compartmentation Load Case and Cargo Types
(on page 33). You can also define cargo rules, which define the load on a compartment based
on the cargo the compartment is holding.

Define Interference Zones and Regions


In addition to the interference zones and regions that are delivered with the software, you can
add types to the catalog. For more information, see Interference Zones (on page 37) and
Regions (on page 39).

Define Compartmentation Rules and Custom Attributes


You can define rules and custom attributes for compartmentation. For more information, see
Compartmentation Generic Services (on page 45).

Define Compartmentation Labels and Reports


You can define labels and reports that show the attributes for compartments and loads. For
more information, see Compartmentation Labels and Reports (on page 49).

Define Compartmentation Codelists


Codelists, also known as select lists, are useful when attributes can have one of many values.
You can define compartmentation-specific codelists. For more information, see
Compartmentation Codelists (on page 51), Interference Zones Codelists (on page 59), and
Regions Codelists (on page 61).

See Also
Understanding the Compartmentation Reference Data Workflow (on page 20)

Move Custom DLLs to SharedContent Folder


Custom DLLs are any DLLs that are not originally delivered with SmartMarine 3D or delivered
DLLs that have been modified by you to suit a specific purpose. Starting with Version 2009 (8.0)
of SmartMarine 3D, custom DLLs should be saved in the SharedContent\Custom Symbols
folder on your SharedContent share. Use the following workflow to copy your customized DLLs
to this single location instead of registering each DLL on all client computers.
1. Recompile each Visual Basic project in a Version 2011 R1 (9.1) client installation.
2. Copy the new DLLs to the [Reference Data Folder]\SharedContent\Custom Symbols folder.

You can create hierarchy folders as needed under the Custom Symbols folder.

Compartmentation Reference Data Guide

23

Compartmentation Reference Data

If a custom DLL has a localizer DLL, both files should be located in the same folder.
DLLs ending "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 where
your custom DLLs are located.
4. Select Tools > Update Custom Symbol Configuration or right-click the catalog node, and
select Update Custom Symbol Configuration.
The command creates or updates the file called CustomSymbolConfig.xml 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 the need of
registering the DLL on the local computer.

24

The software searches [Reference Data


Folder]\SharedContent]\Xml\CustomSymbolConfig.xml first and then
SystemSymbolConfig.xml. If there are duplicate entries in CustomSymbolConfig.xml and
SymbolSymbolConfigSymbolSymbolConfig.xml for the same ProgID, an error or warning is
written to the error log that appears when the Update Custom Symbol Configuration
command finishes processing, and the DLL is not added to either XML file
(CustomSymbolConfig.xml and SystemSymbolConfig.xml). Please clear any errors or
warnings that appear in the error log after running this command to prevent such a scenario.
Whenever a symbol or naming rule class is accessed, the software searches for the DLL as
follows:
a. It checks if an entry for the ProgID exists in the xml files. If an entry exists, then the
corresponding DLL is loaded and an instance of the class is created.
b. If an entry does not exist, it searches previously registered DLLs on the local computer.
c. If any entry is not found for the ProgID in either XML file and the DLL is also not
registered on the local machine, the software returns an error. In this case, you should
copy the DLL to the [Reference Data Folder]\SharedContent\Custom Symbols folder,
and run the Update Custom Symbol Configuration command in Project Management.
If an entry exists for a ProgID in the xml files, it is used even though another (or same) copy
of the DLL is registered on the local machine. The order of priority when creating an
instance of an object is: CustomSymbolConfig.xml, SystemSymbolConfig.xml, and then the
registry.
When a new custom DLL is added to the[Reference Data Folder]\SharedContent\Custom
Symbols folder or an existing custom DLL is modified, you must re-run the Tools > Update
Custom Symbol Configuration command in Project Management.
If you choose to use option 1, then the custom DLLs in the [Reference Data
Folder]\SharedContent\Custom Symbols folder should not be registered on the local
computer.
If any of these components use helper classes and the helper classes are instantiated by
calling "CreateObject", the "CreateObject" needs to be replaced. If the helper class is in the
same project, then "new" can be used instead of "CreateObject". If the helper class is in a
different project, then "SP3DCreateObject" needs to be used instead of "CreateObject".
SP3DCreateObject tries to instantiate the object using the information in xml files. If no entry
is found in xml files for the given ProgID, then it calls "CreateObject". SP3DCreateObject is
implemented in [Product Folder]\Core\Runtime\SP3DCoCreateInstance.dll. When
SP3DCreateObject needs to be used, [Product

Compartmentation Reference Data Guide

Compartmentation Reference Data

Folder]\Core\Runtime\SP3DCoCreateInstance.dll needs to be referenced in the Visual Basic


project. Example usage of SP3DCreateObject is shown below:
Set oHelperObject = SP3DCreateObject(strHelperProgId)
If the symbol class has any public structures or types, they should be made private. For
example:
Public Type InputType
Name As String
Description As String
Properties As IMSDescriptionProperties
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 SmartMarine 3D Support
representative if you have questions.

Compartmentation Reference Data Guide

25

Compartmentation Reference Data

26

Compartmentation Reference Data Guide

SECTION 2

Compartmentation Part Classes and


Load Case Types
The Compartments.xls workbook contains worksheets that define all of the compartment part
classes, void spaces, load case types, and cargo types that are available in the catalog. In
addition, this workbook contains load rules for different types of cargo.
You can add new data to the workbook, or you can modify or delete the data already there. After
making changes, you must bulk load to see the changes reflected in the software.

See Also
Compartmentation Reference Data (on page 19)
Understanding the Compartmentation Reference Data Workflow (on page 20)
What's New in Compartmentation Reference Data (on page 17)
Compartmentation Part Classes (on page 27)
Compartmentation Part Classes and Load Case Types (on page 27)
Compartmentation Load Case and Cargo Types (on page 33)

Compartmentation Part Classes


The delivered compartmentation reference data includes compartment tanks, unknown and void
compartments, habitable compartments, compartments for cargo and machinery, and ship
zones for planning, fire, and damage control.
In addition, void spaces are provided. These volumes set aside space reservation in a model.
Compartments, void spaces, 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. You can enter NULL in this field or leave it blank.

See Also
Compartmentation Part Classes and Load Case Types (on page 27)

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.
Description - Part description.
DesignBulkCargoMassMh - Homogenous load in all cargo hold (load dependent input).
DesignBulkCargoMassMhd - Alternate load in all cargo holds (load dependent input).

Compartmentation Reference Data Guide

27

Compartmentation Part Classes and Load Case Types

LengthOfHatch - Inside length of hatch.


Mass - Mass of the load that is supposed to be carried in the compartment.
Name - Part name as it appears in the Catalog task. This identification must be unique
across the entire catalog.
natural_angle_of_repose - Angle that forms between the horizontal at the top of a pile of
unconsolidated material, and the sides.
permeability - Measure of how easily fluid (e.g., water) can pass through a porous medium.
ReducedVolume - Used in FEA 1A1 bulk vessels. Volume of bulk load (Rules gives filling
hight: calculate volume of load).
stowage_factor TopOfHatch - Top of hatch.
trimmed - Natural pile of cargo type that has been flattened and spread out to fill the
compartment.
volume - Volume of compartment.

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 it appears 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 it appears 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.

28

Compartmentation Reference Data Guide

Compartmentation Part Classes and Load Case Types

PartDescription - Part description.


PartNumber - Part number or name as it appears 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 it appears 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 it appears 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.

Compartmentation Reference Data Guide

29

Compartmentation Part Classes and Load Case Types

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 it appears 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 it appears 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 it appears in the Catalog task. This identification
must be unique across the entire catalog.

30

Compartmentation Reference Data Guide

Compartmentation Part Classes and Load Case Types


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 it appears 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 it appears 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):

Compartmentation Reference Data Guide

31

Compartmentation Part Classes and Load Case Types

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
Name - Part name as it appears 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.
specific_heat_capacity - Amount of energy required to raise the temperature of a kilogram
of a material by 1 degree Centigrade.
thermal_conductivity - Rate at which a material conducts heat.
viscosity - Measured resistance to flow.

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 it appears 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.

32

Compartmentation Reference Data Guide

Compartmentation Part Classes and Load Case Types

LiquidPressure - Fluid pressure per unit area.


Name - Part name as it appears 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 it appears 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 it appears 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.

Compartmentation Load Case and Cargo Types


The delivered compartmentation reference data includes load case types and cargo types for
gases, liquids, and other materials.
Below is a complete listing of all the properties, both common and unique, that you will see on a
load case or cargo type sheet. Occurrence properties are not listed.

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.

Compartmentation Reference Data Guide

33

Compartmentation Part Classes and Load Case Types


Unique Properties
Unique properties appear only for certain classes.
Custom Program - Enter 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 27)

Compartmentation Cargo Rules


The delivered compartmentation reference data includes cargo rules that can define the load on
a compartment based on the type of cargo the compartment is holding.
Below is a complete listing of all the properties, both common and unique, that you will see on
the cargo rules sheet. Occurrence properties are not listed.
The properties are listed here in the order that they appear, from left to right, on the part sheet.
Rule Name - Type the name for the rule.
Compartment Object - Enter the type of compartment object, such as CompartmentTank.
Load Type - Enter the type of load, such as GaseousCargoType.

See Also
Compartmentation Part Classes and Load Case Types (on page 27)

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 it appears in the Catalog task.

34

Compartmentation Reference Data Guide

Compartmentation Part Classes and Load Case Types

Compartmentation Reference Data Guide

35

SECTION 3

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 19)
Understanding the Compartmentation Reference Data Workflow (on page 20)
What's New in Compartmentation Reference Data (on page 17)
Interference Zone Type Sheet (on page 37)

Interference Zone Type Sheet


The Interference Zone Type sheet in the InterferenceZones.xls workbook defines the
interference zones for compartmentation.
This topic describes the Head/Start/End section of the sheet. For information about the
Definition section, see the SmartMarine 3D Reference Data Guide, available from the Help >
Printable Guides command.
Part Number - Type the unique identification for the part as found in the catalog data.
Part Description - Type a description for the part.
Mirror Behavior Option - Enter the 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.
Symbol Definition - Type the symbol definition for the part.
Compartments are not represented by symbols, so you do not need to be concerned with
symbol creation and definition. You can enter NULL in this field or leave it blank.
Type - Enter a code for the type of interference zone. Valid codes are listed in the
InterferenceZoneCodeLists.xls workbook on the Interference Type sheet in the Codelist
Number column.
The Type attribute is an occurrence attribute, denoted by oa: in the Definition section of the
worksheet.

See Also
Interference Zones (on page 37)

Compartmentation Reference Data Guide

37

Interference Zones

38

Compartmentation Reference Data Guide

SECTION 4

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 19)
Understanding the Compartmentation Reference Data Workflow (on page 20)
What's New in Compartmentation Reference Data (on page 17)
Region Corrosion Sheet (on page 39)

Region Corrosion Sheet


The Region Corrosion sheet in the Regions.xls workbook defines the types of regions for
compartmentation.
This topic describes the Head/Start/End section of the sheet. For information about the
Definition section, see the SmartMarine 3D Reference Data Guide, available from the Help >
Printable Guides command.
Part Number - Type the unique identification for the part as found in the catalog data.
Part Description - Type a description for the part.
Mirror Behavior Option - Enter the 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.
Symbol Definition - Type the symbol definition for the part.
Compartments are not represented by symbols, so you do not need to be concerned with
symbol creation and definition. You can enter NULL in this field or leave it blank.
The following three attributes are occurrence attributes, denoted by oa: in the Definition section
of this worksheet.
Ship Type - Enter a code for the type of ship. Valid codes are listed in the
RegionCodeLists.xls workbook on the Region Ship Type sheet in the Codelist Number
column.
Region Type - Enter a code for the type of region. Valid codes are listed in the
RegionCodeLists.xls workbook on the Region Type sheet in the Codelist Number column.
Corrosion Rule - Displays a code for the corrosion rule associated with this region. This value
is defined internally by the software. Do not modify.

See Also
Regions (on page 39)

Compartmentation Reference Data Guide

39

Regions

40

Compartmentation Reference Data Guide

SECTION 5

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

Compartmentation Reference Data Guide

41

Compartmentation Symbols
Ellipse

Hexagon

Sector

Road

TrapezoidR (right angle)

42

Compartmentation Reference Data Guide

Compartmentation Symbols
TrapezoidC (concentric)

I-Beam

See Also
Compartmentation Reference Data (on page 19)
Understanding the Compartmentation Reference Data Workflow (on page 20)
What's New in Compartmentation Reference Data (on page 17)

Compartmentation Reference Data Guide

43

Compartmentation Symbols

44

Compartmentation Reference Data Guide

SECTION 6

Compartmentation Generic Services


The CompartGenericServices.xls workbook lists the compartmentation-specific custom
classes, interfaces, and attributes that you want in your catalog. This information is necessary
for the Update Attributes command in the Compartmentation task.
Using custom attributes, you have can control when attributes update and on which objects. You
can also specify the code that calculates the attribute values.
The CompartGenericServices.xls workbook also provides naming rules for compartments and
a rule to check whether compartments overlap.
For more information about custom classes, interfaces, and attributes, as well as naming rules,
see the SmartMarine 3D Reference Data Guide, available from the Help > Printable Guides
command.

See Also
Compartmentation Reference Data (on page 19)
Understanding the Compartmentation Reference Data Workflow (on page 20)
What's New in Compartmentation Reference Data (on page 17)

Compart Split Rule Sheet


The Compart Split Rule sheet in the CompartGenericServices.xls workbook provides a rule
that checks whether compartments overlap.
This topic describes the Head/Start/End section of the sheet. For information about the
Definition section, see the SmartMarine 3D Reference Data Guide, available from the Help >
Printable Guides command.
Name - Specifies a name for the rule. This name is solely for bulkloading purposes and does not
appear on the user interface of the software.
Attribute Name - Specifies a descriptive name for the rule. This name is more user-friendly and
can have spaces; this name appears on the Catalog task user interface.
Type - Specifies the type of query for the rule.
Subtype - Specifies the subtype of query for the rule.
Custom Program - Provides the name of a Visual Basic project and class that is used to
perform the calculation. The Visual Basic source code for this custom program (rule) is delivered
in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplit
Rule folder.
Query Order - Specifies the order in which the query runs.

See Also
Compartmentation Generic Services (on page 45)

Compartmentation Reference Data Guide

45

Compartmentation Generic Services

Compartment Custom Attribute Sheet


The Compartment Custom Attribute sheet in the CompartGenericServices.xls workbook
defines custom attributes for compartmentation. You use this information when running the
Update Attributes command in the Compartmentation task.
This topic describes the Head/Start/End section of the sheet. For information about the
Definition section, see the SmartMarine 3D Reference Data Guide, available from the Help >
Printable Guides command.
Name - Specifies a name for the custom attribute. This name is solely for bulkloading purposes
and does not appear on the user interface of the software.
Attribute Name - Specifies a descriptive name for the attribute. This name is more user-friendly
and can have spaces; this name appears on the Catalog task user interface.
Rule Name - Specifies the rule associated with the attribute. This field is optional and can be left
blank.
Order - Allows you to use the previously calculated attribute values as a reference to process
the next set of attributes.
Custom Class - Specifies the name of the class associated with the attribute. This class is
listed on the Custom Class Interface List sheet in this workbook.
Virtual Interface - Specifies the name of the interface associated with the attribute. This
interface is listed on the Custom Class Interface List sheet in this workbook.
Custom Program - Provides the name of a Visual Basic project and class that is used to
calculate the attribute. The Visual Basic source code for these rules is delivered in
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute
(CompartSemantics) and[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Region\CustomCompute
(RegionSemantics).
Semantic Control - Controls when the custom code for the attribute is run.
1 = Execute during compute (for example, modification of object)
2 = Execute during commit (for example, creation of object)
4 = Execute by user request (Update Attributes command in software)

See Also
Compartmentation Generic Services (on page 45)

Custom Class Interface List Sheet


The Custom Class Interface List sheet in the CompartGenericServices.xls workbook maps
interfaces to compartmentation classes. You use this information when running the Update
Attributes command in the Compartmentation task.
Class Name - Lists the name of a non-virtual, system class. For example, type CCompartment.
Interface Name - Lists the name of a custom virtual interface.

See Also
Compartmentation Generic Services (on page 45)

46

Compartmentation Reference Data Guide

Compartmentation Generic Services

Naming Rules Sheet


The Naming Rules sheet in the CompartGenericServices.xls workbook lists the naming rules
for compartments.
TypeName - Specifies the internal class names of objects. The type names appear in the
Catalog hierarchy under the NamingRules folder.
Name - Specifies the rule name. You can use the same naming rule for more than one object
type. See Naming Rules (on page 47) for the conventions used by each of the
compartmentation naming rules.
SolverProgID - Lists the ProgID for the naming rule, using the format [project name].[class
name]. The Visual Basic source code for compartment naming rules is delivered in the following
folders:
Compartments (frame rule) - [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming
Loads - [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\Naming
General Volumes - [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Ruless\GeneralVolume\Naming
Load Combinations - [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\LoadCombination\Naming

See Also
Compartmentation Generic Services (on page 45)

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

Compartmentation Reference Data Guide

47

Compartmentation Generic Services


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.

48

Compartmentation Reference Data Guide

SECTION 7

Compartmentation Labels and Reports


The Compartmentation reference data includes labels (tooltips) and reports.

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

Compart Tightness Tooltip

Displays the tightness property of a compartment.

Compart Tooltip General

Displays the name and surface area of a


compartment.

Load General Tooltip

Displays the name of a load.

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

Compartment Attributes
Report

Displays a list of compartments and their associated


properties: part description, volume, surface area, and
center of gravity coordinates.

CompartPaintingArea

Displays the exposed surface area of structural


objects (plates and profiles) for estimating total paint
area. The report shows the objects which are in
contact with the compartment in the following ways:

Overlapping
OutsideAndTouching
InsideAndTouching
Inside
Boundary

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

Compartmentation Reference Data Guide

49

Compartmentation Labels and Reports


Report

Description

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 Tightness
Report

Displays a list of compartments and their tightness


properties: part description, compartment tightness,
structural tightness, plate, and plate tightness.

Compartments And Zones


Report

Displays a list of compartments and connected zones.


This report includes the type of compartment and type
of zone.

Connected Compartments
Report

Displays a list of compartments that are adjacent.

Load Combination And


Relations Report

Displays a list of load combinations, including the


associated spatial loads, connected compartments,
unit loads, and load folders. This report provides a
load combination overview.

Objects inside the


Compartments

Displays a list of compartments, their part


descriptions, and the objects inside the
compartments. This report requires you to select a
filter during runtime.

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


Report

Displays a list of unit loads and their parent folders.


This report provides a unit load overview.

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 19)
Understanding the Compartmentation Reference Data Workflow (on page 20)
What's New in Compartmentation Reference Data (on page 17)

50

Compartmentation Reference Data Guide

SECTION 8

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 SmartMarine 3D Reference Data Guide, available
from the Help > Printable Guides command.

See Also
Compartmentation Reference Data (on page 19)
Understanding the Compartmentation Reference Data Workflow (on page 20)
What's New in Compartmentation Reference Data (on page 17)

Compartmentation Reference Data Guide

51

Compartmentation Codelists
In This Section
Compart Coating Color Codelist .................................................... 53
Compart Coating Process Codelist ............................................... 53
Compart Coating Responsibility Codelist ...................................... 53
Compart Coating Status Codelist .................................................. 53
Compart Coating Type Codelist..................................................... 53
Compartment Authorization Class Codelist ................................... 53
Compartment Bulk Cargo Type Codelist ....................................... 53
Compartment Bulkhead Tightness Codelist .................................. 53
Compartment Capacity Context Codelist ...................................... 53
Compartment Cargo Context Codelist ........................................... 54
Compartment Coating Applicability Codelist ................................. 54
Compartment Coating Certification Codelist ................................. 54
Compartment Coating Inspection Codelist .................................... 54
Compartment Compartment Group Codelist ................................. 54
Compartment Compartment Type Codelist ................................... 54
Compartment Contact Material Type Codelist............................... 54
Compartment Damage Location Codelist...................................... 54
Compartment Damage Type Codelist ........................................... 54
Compartment Design Requirement Codelist ................................. 55
Compartment Function Type Codelist ........................................... 55
Compartment Insulation Category Codelist ................................... 55
Compartment Naval Nuclear Class Codelist ................................. 55
Compartment Naval Safety Category Codelist .............................. 55
Compartment Naval Security Class Codelist................................. 55
Compartment Noise Category Codelist ......................................... 55
Compartment Positional Rel Type Codelist ................................... 55
Compartment Property Context Codelist ....................................... 55
Compartment Relevant Cargos Codelist ....................................... 56
Compartment Structure Type Codelist .......................................... 56
Compartment Surface Preparation Codelist .................................. 56
Load Case Liquid Pressure Codelist ............................................. 56
Load Case Sea Pressure Codelist ................................................ 56
Ship Design Loading Condition Type Codelist .............................. 56
Space Access Type Codelist ......................................................... 56
Space Adjacency Contact Type Codelist ...................................... 56
Space Adjacency Geometry Type Codelist ................................... 56
Space Arrangement Orientation Codelist ...................................... 57
Space Arrangement Type Codelist ................................................ 57
Space Item Purpose Codelist ........................................................ 57
Space Physical Orientation Type Codelist .................................... 57
Space Positional Relationship Type Codelist ................................ 57
Space Product Structure Type Codelist ........................................ 57

52

Compartmentation Reference Data Guide

Compartmentation Codelists

Compart Coating Color Codelist


The Compart Coating Color sheet defines the available coating colors for compartments. This
codelist is used in the reference data for the Compartmentation task.

Compart Coating Process Codelist


The Compart Coating Process sheet specifies the different coating processes for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compart Coating Responsibility Codelist


The Compart Coating Responsibility sheet defines the list of responsible parties available for
applying the coating to compartments. This codelist is used in the reference data for the
Compartmentation task.

Compart Coating Status Codelist


The Compart Coating Status sheet lists the different statuses for compartment coatings. This
codelist is used in the reference data for the Compartmentation task.

Compart Coating Type Codelist


The Compart Coating Type sheet lists the types of coatings that you want to use for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Authorization Class Codelist


The Compartment Authorization Class sheet specifies the levels of authorization for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Bulk Cargo Type Codelist


The Compartment Bulk Cargo Type sheet specifies the different types of bulk cargo for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Bulkhead Tightness Codelist


The Compartment Bulkhead Tightness sheet specifies the levels of bulkhead tightness for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Capacity Context Codelist


The Compartment Capacity Context sheet specifies the levels of capacity for compartments.
This codelist is used in the reference data for the Compartmentation task.

Compartmentation Reference Data Guide

53

Compartmentation Codelists

Compartment Cargo Context Codelist


The Compartment Cargo Context sheet specifies the levels of cargo context for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Coating Applicability Codelist


The Compartment Coating Applicability sheet specifies the coating applicability options for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Coating Certification Codelist


The Compartment Coating Certification sheet specifies the levels of coating certification for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Coating Inspection Codelist


The Compartment Coating Inspection sheet specifies the coating inspection options for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Compartment Group Codelist


The Compartment Compartment Group sheet specifies the groups for compartments. This
codelist is used in the reference data for the Compartmentation task.

Compartment Compartment Type Codelist


The Compartment Compartment Type sheet specifies the different types for compartments.
This codelist is used in the reference data for the Compartmentation task.

Compartment Contact Material Type Codelist


The Compartment Contact Material Type sheet specifies the types of contact materials for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Damage Location Codelist


The Compartment Damage Location sheet specifies the damage locations for compartments.
This codelist is used in the reference data for the Compartmentation task.

Compartment Damage Type Codelist


The Compartment Damage Type sheet specifies the types of damage for compartments. This
codelist is used in the reference data for the Compartmentation task.

54

Compartmentation Reference Data Guide

Compartmentation Codelists

Compartment Design Requirement Codelist


The Compartment Design Requirement sheet specifies the design requirement options for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Function Type Codelist


The Compartment Function Type sheet specifies the types of functions for compartments.
This codelist is used in the reference data for the Compartmentation task.

Compartment Insulation Category Codelist


The Compartment Insulation Category sheet specifies the categories of insulation for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Naval Nuclear Class Codelist


The Compartment Naval Nuclear Class sheet specifies the naval nuclear classes for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Naval Safety Category Codelist


The Compartment Naval Safety Category sheet specifies the categories of naval safety for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Naval Security Class Codelist


The Compartment Naval Security Class sheet specifies the classes of naval security for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Noise Category Codelist


The Compartment Noise Category sheet specifies the categories of noise levels for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Positional Rel Type Codelist


The Compartment Positional Rel Type sheet specifies the types of positional relationships for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Property Context Codelist


The Compartment Property Context sheet specifies the property context options for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartmentation Reference Data Guide

55

Compartmentation Codelists

Compartment Relevant Cargos Codelist


The Compartment Relevant Cargos sheet specifies the relevant types of cargo for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Structure Type Codelist


The Compartment Structure Type sheet specifies the types of structure for compartments.
This codelist is used in the reference data for the Compartmentation task.

Compartment Surface Preparation Codelist


The Compartment Surface Preparation sheet specifies the different types of surface
preparation for compartments. This codelist is used in the reference data for the
Compartmentation task.

Load Case Liquid Pressure Codelist


The Load Case Liquid Pressure sheet specifies liquid pressure ratings for load cases on
compartments. This codelist is used in the reference data for the Compartmentation task.

Load Case Sea Pressure Codelist


The Load Case Sea Pressure sheet specifies sea pressure ratings for load cases on
compartments. This codelist is used in the reference data for the Compartmentation task.

Ship Design Loading Condition Type Codelist


The Ship Design Loading Condition Type sheet specifies the loading condition types for
compartments. This codelist is used in the reference data for the Compartmentation task.

Space Access Type Codelist


The Space Access Type sheet specifies the types of access for space objects. This codelist is
used in the reference data for the Compartmentation task.

Space Adjacency Contact Type Codelist


The Space Adjacency Contact Type sheet specifies the adjacency contact types for space
objects. This codelist is used in the reference data for the Compartmentation task.

Space Adjacency Geometry Type Codelist


The Space Adjacency Geometry Type sheet specifies the adjacency geometry types for space
objects. This codelist is used in the reference data for the Compartmentation task.

56

Compartmentation Reference Data Guide

Compartmentation Codelists

Space Arrangement Orientation Codelist


The Space Arrangement Orientation sheet specifies arrangement options for space objects.
This codelist is used in the reference data for the Compartmentation task.

Space Arrangement Type Codelist


The Space Arrangement Type sheet specifies the types of arrangements for space objects.
This codelist is used in the reference data for the Compartmentation task.

Space Item Purpose Codelist


The Space Item Purpose sheet specifies lists the item purposes for space objects. This codelist
is used in the reference data for the Compartmentation task.

Space Physical Orientation Type Codelist


The Space Physical Orientation Type sheet specifies the types of physical orientation for
space objects. This codelist is used in the reference data for the Compartmentation task.

Space Positional Relationship Type Codelist


The Space Positional Relationship Type sheet specifies the types of positional relationships
for space objects. This codelist is used in the reference data for the Compartmentation task.

Space Product Structure Type Codelist


The Space Product Structure Type sheet specifies the type of structure for space objects. This
codelist is used in the reference data for the Compartmentation task.

Compartmentation Reference Data Guide

57

Compartmentation Codelists

58

Compartmentation Reference Data Guide

SECTION 9

Interference Zones Codelists


The InterferenceZoneCodeLists.xls workbook specifies the interference zone-specific
codelists in your catalog.
For more information about codelists, see the SmartMarine 3D Reference Data Guide, available
from the Help > Printable Guides command.

See Also
Compartmentation Reference Data (on page 19)
Understanding the Compartmentation Reference Data Workflow (on page 20)
What's New in Compartmentation Reference Data (on page 17)

Interference Type Codelist


The Interference Type sheet lists the different types of interference zones that are available
when you create or modify these zones in the model. This codelist is used in the reference data
for the Compartmentation task.

Compartmentation Reference Data Guide

59

Interference Zones Codelists

60

Compartmentation Reference Data Guide

SECTION 10

Regions Codelists
The RegionCodeLists.xls workbook specifies the regions- specific codelists in your catalog.
For more information about codelists, see the SmartMarine 3D Reference Data Guide, available
from the Help > Printable Guides command.

See Also
Compartmentation Reference Data (on page 19)
Understanding the Compartmentation Reference Data Workflow (on page 20)
What's New in Compartmentation Reference Data (on page 17)

Region Ship Type Codelist


The Region Ship Type sheet lists the different types of ships that are available when you create
or modify regions in the model. This codelist is used in the reference data for the
Compartmentation task.

Region Type Codelist


The Region Type sheet lists the different types of regions that are available when you create or
modify regions in the model. This codelist is used in the reference data for the
Compartmentation task.

Compartmentation Reference Data Guide

61

Regions Codelists

62

Compartmentation Reference Data Guide

Index
B
BulkCargoType 27

C
CmpartZoneCPS 28
CmpartZoneDamageControl 28
CmpartZoneFire 28
CmpartZonePlanning 29
Compart Coating Color Codelist 53
Compart Coating Process Codelist 53
Compart Coating Responsibility Codelist
53
Compart Coating Status Codelist 53
Compart Coating Type Codelist 53
Compart Split Rule Sheet 45
Compartment Authorization Class Codelist
53
Compartment Bulk Cargo Type Codelist
53
Compartment Bulkhead Tightness Codelist
53
Compartment Capacity Context Codelist
53
Compartment Cargo Context Codelist 54
Compartment Coating Applicability Codelist
54
Compartment Coating Certification Codelist
54
Compartment Coating Inspection Codelist
54
Compartment Compartment Group Codelist
54
Compartment Compartment Type Codelist
54
Compartment Contact Material Type
Codelist 54
Compartment Custom Attribute Sheet 46
Compartment Damage Location Codelist
54
Compartment Damage Type Codelist 54
Compartment Design Requirement Codelist
55
Compartment Function Type Codelist 55
Compartment Insulation Category Codelist
55
Compartment Naval Nuclear Class Codelist
55

Compartmentation Reference Data Guide

Compartment Naval Safety Category


Codelist 55
Compartment Naval Security Class Codelist
55
Compartment Noise Category Codelist 55
Compartment Positional Rel Type Codelist
55
Compartment Property Context Codelist
55
Compartment Relevant Cargos Codelist
56
Compartment Structure Type Codelist 56
Compartment Surface Preparation Codelist
56
Compartmentation Cargo Rules 34
Compartmentation Codelists 51
Compartmentation Generic Services 45
Compartmentation Labels and Reports 49
Compartmentation Load Case and Cargo
Types 33
Compartmentation Part Classes 27
Compartmentation Part Classes and Load
Case Types 27
Compartmentation Reference Data 19
Compartmentation Reference Data
Common Tasks 23
Compartmentation Symbols 41
CompartmentCargo 29
CompartmentCargoRule 34
CompartmentHabitable 29
CompartmentMachinery 30
CompartmentTank 30
CompartmentUnknown 31
CompartmentVoid 31
Custom Class Interface List Sheet 46

D
Documentation Comments 13

G
GaseousCargoType 31

I
Interference Type Codelist 59
Interference Zone Type Sheet 37
Interference Zones 37
Interference Zones Codelists 59

63

Index

LiquidCargoType 32
Load Case Liquid Pressure Codelist 56
Load Case Sea Pressure Codelist 56
LoadCaseType 32

VoidSpace 33

W
What's New in Compartmentation
Reference Data 17

Move Custom DLLs to SharedContent


Folder 23

N
Naming Rules 47
Naming Rules Sheet 47

P
Preface 7

R
Region Corrosion Sheet 39
Region Ship Type Codelist 61
Region Type Codelist 61
Regions 39
Regions Codelists 61

S
Ship Design Loading Condition Type
Codelist 56
SmartMarine 3D and Oracle 15
SmartMarine 3D Documentation Set 9
Space Access Type Codelist 56
Space Adjacency Contact Type Codelist
56
Space Adjacency Geometry Type Codelist
56
Space Arrangement Orientation Codelist
57
Space Arrangement Type Codelist 57
Space Item Purpose Codelist 57
Space Physical Orientation Type Codelist
57
Space Positional Relationship Type
Codelist 57
Space Product Structure Type Codelist 57

U
Understanding the Compartmentation
Reference Data Workflow 20
UnitCargoType 33

64

Compartmentation Reference Data Guide

Potrebbero piacerti anche