Compartment at i on Reference Data Guide

8/18/2019 Compartment at i on Reference Data Guide

1/64

CompartmentationReference Data Guide

Version 2011 R1 (9.1)

May 2012

DSHIP-PE-200078G


2/64

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, tradesecret law, and international treaty, and may not be provided or otherwise made available without proper authorization fromIntergraph Corporation.

Portions of this software are owned by Spatial Corp. © 1986-2010. All Rights Reserved.

U.S. Government Restricted Righ ts Legend

Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This wasdeveloped at private expense and is "restricted computer software" submitted with restricted rights in accordance withsubparagraphs (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 ofthe United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS252.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 CorporationP.O. Box 240000Huntsville, AL 35813

Terms of Use

Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unlessthe 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 l icense shall take precedence and govern the useof this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation giveslicensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreementand delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed forresale or redistribution.

Warranties and Liabilit ies

All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the softwareor applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, thisdocument or its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believesthe 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 applicabletechnical 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 theterms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is notsupplied 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 trademarksof Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registeredtrademarks of Microsoft Corporation. ACIS is a registered trademark of SPATIAL TECHNOLOGY, INC. Infragistics, PresentationLayer Framework, ActiveTreeView Ctrl, ProtoViewCtl, ActiveThreed Ctrl, ActiveListBar Ctrl, ActiveSplitter, ActiveToolbarsCtrl, ActiveToolbars Plus Ctrl, and ProtoView are trademarks of Infragistics, Inc. Incorporates portions of 2D DCM, 3D DCM, andHLM 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 ofComponentOne LLC 1991-2009, All rights reserved. Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks ofOracle Corporation and/or its affiliates. Tribon is a trademark of AVEVA Group plc. Alma and act/cut are trademarks of the Almacompany. Other brands and product names are trademarks of their respective owners.


3/64

Compartmentation Reference Data Guide 3

ContentsPreface .......................................................................................................................................................... 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 Generi c Services ...................................................................................................... 45

Compart Split Rule Sheet ..................................................................................................................... 45 Compartment Custom Attribute Sheet .................................................................................................. 46


4/64

Contents

4 Compartmentation Reference Data Guide

Custom Class Interface List Sheet........................................................................................................ 46 Naming Rules Sheet ............................................................................................................................. 47

Naming Rules ................................................................................................................................. 47

Compartmentation Labels and Repor ts .................................................................................................. 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 Codel is ts ................................................................................................................... 59

Interference Type Codelist .................................................................................................................... 59


5/64

Contents


Regions Codel ists ..................................................................................................................................... 61

Region Ship Type Codelist ................................................................................................................... 61 Region Type Codelist ............................................................................................................................ 61

Index ........................................................................................................................................................... 63


6/64

Contents



7/64


This document is a reference data guide for the SmartMarine 3D Compartmentation task. Thepurpose of this document is to describe the reference data delivered with the software for thistask.

Reference data includes both catalog data and specification data. Catalog data includes theparts that you place in the model, such as piping components and equipment. Specification dataincludes the rules that govern how those parts are placed and connected.

Preface


8/64

Preface



9/64


SmartMarine 3D Documentation SetSmartMarine 3D documentation is available as Adobe PDF files. The content is the same asonline 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, andtroubleshooting SmartMarine 3D.

User's guides provide command reference and how-to information for working in eachSmartMarine 3D task.

Reference data guides define the reference data workbooks. Not all tasks have referencedata.

ISOGEN guides

Administrat ive Guides

SmartMarine 3D Installation Guide - Provides instructions on installing and configuring thesoftware.

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 themodel, defining and managing locations for Global Workshare, and version migration.

SmartMarine 3D Global Workshare Guide - Provides instructions for setting up the software andthe 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 tointerpret human piping specifications so that you can create the corresponding pipingspecification 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 ofthe export functionality are also included.

SmartMarine 3D Point Cloud Reference - Provides information for referencing point cloud filesprovided by point cloud vendors in SmartMarine 3D.

SmartMarine 3D Troubleshooting Guide - Provides information on how to resolve errors that youmay encounter in the software by documenting troubleshooting tips, error messages, and To DoList messages.

SmartMarine 3D Plant Design System (PDS) Guide - Provides all information needed to usePDS 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 referencedata 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 installthe 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 dataand select lists (codelists).


10/64


11/64

Preface


Compartmentation Reference Data Guide - Provides information about compartmentationreference data.

Drawings and Reports Reference Data Guide - Provides information about reports referencedata.

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 3Dsymbols that are available.

Equipment and Furnishings Reference Data Guide - Provides information about equipmentreference data.

Equipment 3D Symbols Reference - Provides information about the equipment, equipmentcomponent, design shapes, and design aides 3D symbols that are available.

Hangers and Supports Reference Data Guide - Provides information about hangers andsupports reference data.

Hangers and Supports 3D Symbols Reference - Provides information about the hanger andsupport 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 areavailable.

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 pipingspecifications, piping specification rules, piping parts, and piping symbols.

Piping 3D Symbols Reference - Provides information about the piping 3D symbols that areavailable.

Space Management Reference Data Guide - Provides information about space managementreference data.

Structure Reference Data Guide - Provides information about structural reference data.

Structure 3D Symbols Reference - Provides information about the stair, ladder, footings, andequipment foundation 3D symbols that are available.

SmartMarine 3D Structural Reference Data Overview - Provides an overview of theSmartMarine 3D structural reference data library.

ISOGEN Guides

Symbol Keys Reference Guide - Provides information about the symbol keys for isometricdrawings. This guide is from Alias, the makers of ISOGEN.


12/64

Preface



13/64


Documentation CommentsWe welcome comments or suggestions about this documentation. You can send us an email at:[email protected].

Documentation updates for supported software versions are available from eCustomer

https://crmweb.intergraph.com.

https://crmweb.intergraph.com/https://crmweb.intergraph.com/https://crmweb.intergraph.com/


14/64

Preface



15/64


SmartMarine 3D and OracleSmartMarine 3D shares much of its functionality with Intergraph's plant design software,SmartPlant 3D. Because of this shared functionality, you will see throughout the softwarereferences and options pertaining to Oracle databases, which SmartPlant 3D supports but

SmartMarine 3D does not. Please remember that when using SmartMarine 3D, to always selectthe SQL option when given a choice between Oracle and SQL.


16/64

Preface



17/64


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.

What's New in CompartmentationReference Data


18/64

What's New in Compartmentation Reference Data



19/64


S E C T I O N 1

Each organization using the software requires customized reference data such as rules, catalogitems, and symbols to meet their exact needs. Customized rules control how and when thecatalog items and symbols are used in the model.

Before working with compartmentation reference data, you must be familiar with how thesoftware handles reference data in general. If you have not already done so, read andunderstand the following important concepts and procedures described in the SmartMarine 3DReference 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 deliveredwith the software. Microsoft Excel workbooks are delivered for bulkloading items into theCatalog. 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 needto 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 sourcecode, delivered to the [Reference DataFolder ]\Compartmentation\Data\Symbols\Compartmentation\Shapes folder. The files in thisfolder are not used by Compartmentation. This project is for reference and can be used forcustomization purposes.

For more information about symbols, see the Equipment 3D Symbols Reference andSmartMarine 3D 2D Symbols Reference Data Guide.

Compartmentation Reference Data


20/64



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 Appl ication Programming Interface

An application programming interface (API), CompartQueryServices.dll, is provided in thesoftware for common objects, methods, and properties used in the Compartmentation queryservice custom command. For more information, see the Compartmentation Query ServicesCustomization documentation, which also describes the Compartmentation Attribute Helper andCompartmentation Geometry Service Object. This documentation is available as part of theprogramming 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 DataWorkflow

The reference data for the Compartmentation task is divided into the following areas:

Catalog parts, such as compartments, ship zones, load cases, cargo types, interferencezones, 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 relatedreference data files:

Creates and names compartments in the model

Visual Basic Rules:

[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplit

Rule\CompartMergeSpltRule.vbp[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\CompartSemantics.vbp (6 classes)

[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming\CompartmentNamingRules.vbp


21/64



[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\CompartAttributeHelper\CompartHelper.vbp (4 classes)

[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\Naming\CompartRules.vbp (3 classes)

Bulkload Workbook: [ProductFolder ]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\Compartments.xls,CompartmentCodeLists.xls

Visual Basic Symbols: [Reference DataFolder ]\Compartmentation\Data\Symbols\Compartmentation\Shapes (Place Volume Along Pathcommand)

API: CompartQueryServices.dll, CompartAttributeHelper.dll

Creates and names interference zones in the model

Visual Basic Rules:

[Programming Resources

Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplitRule\CompartMergeSpltRule.vbp

[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\CompartSemantics.vbp (6 classes)




Bulkload Workbook:

[Product Folder ]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\InterferenceZones.xls

[ProductFolder ]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\InterferenceZoneCodeLists.xls



Creates and names regions in the modelVisual Basic Rules:

[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplitRule\CompartMergeSpltRule.vbp


22/64



[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\CompartSemantics.vbp (6 classes)




Bulkload Workbook: [ProductFolder ]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\Regions.xls,RegionCodeLists.xls



Creates and names loads and load combinations in the model

Visual Basic Rules:

[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomCompute\CustomLoad.vbp (2 classes)

[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\Naming\LoadNamingRules.vbp (2 classes)

[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\LoadCombination\Naming\LoadCombRules.vbp

[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\SpatialLoad\FilterRule\SpatialFilter.vbp

Bulkload Workbook: [ProductFolder ]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\Compartments.xls


Defines codelist values used by Compartmentation

Bulkload Workbook: [ProductFolder ]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\CompartmentCodeLists.xls, InterferenceZoneCodeLists.xls, RegionCodeLists.xls

See Also

Compartmentation Reference Data Common Tasks (on page 23)


23/64



Compartmentation Reference Data Common TasksBy following these tasks, you can create and customize your own compartmentation referencedata.

Define Compartmentation Part ClassesIn addition to the compartment classes that are delivered with the software, you can add classesto 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 addtypes 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 basedon 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) andRegions (on page 39).

Define Compartmentation Rules and Custom Attributes

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

Define Compartmentation Labels and Reports

You can define labels and reports that show the attributes for compartments and loads. Formore 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, seeCompartmentation Codelists (on page 51), Interference Zones Codelists (on page 59), andRegions Codelists (on page 61).

See Also

Understanding the Compartmentation Reference Data Workflow (on page 20)

Move Custom DLLs to SharedContent FolderCustom DLLs are any DLLs that are not originally delivered with SmartMarine 3D or deliveredDLLs 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 DLLsto 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.


24/64



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 rulesVisual 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 [ReferenceData Folder]\SharedContent\Xml folder. CustomSymbolConfig.xml contains entries with theProgID, CLSID, and DLL name for each class in the custom DLLs. AfterCustomSymbolConfig.xml is created, the software uses the custom DLLs from the[Reference Data Folder]\SharedContent\Custom Symbols folder without the need ofregistering the DLL on the local computer.

The software searches [Reference DataFolder]\SharedContent]\Xml\CustomSymbolConfig.xml first and thenSystemSymbolConfig.xml. If there are duplicate entries in CustomSymbolConfig.xml andSymbolSymbolConfigSymbolSymbolConfig.xml for the same ProgID, an error or warning iswritten 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 orwarnings 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 asfollows:

a. It checks if an entry for the ProgID exists in the xml files. If an entry exists, then thecorresponding 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 notregistered 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) copyof the DLL is registered on the local machine. The order of priority when creating aninstance of an object is: CustomSymbolConfig.xml, SystemSymbolConfig.xml, and then theregistry.

When a new custom DLL is added to the[Reference Data Folder]\SharedContent\CustomSymbols folder or an existing custom DLL is modified, you must re-run the Tools > UpdateCustom Symbol Configuration command in Project Management.

If you choose to use option 1, then the custom DLLs in the [Reference DataFolder]\SharedContent\Custom Symbols folder should not be registered on the localcomputer.

If any of these components use helper classes and the helper classes are instantiated bycalling "CreateObject", the "CreateObject" needs to be replaced. If the helper class is in thesame project, then "new" can be used instead of "CreateObject". If the helper class is in adifferent project, then "SP3DCreateObject" needs to be used instead of "CreateObject".SP3DCreateObject tries to instantiate the object using the information in xml files. If no entryis found in xml files for the given ProgID, then it calls "CreateObject". SP3DCreateObject isimplemented in [Product Folder]\Core\Runtime\SP3DCoCreateInstance.dll. WhenSP3DCreateObject needs to be used, [Product


25/64



Folder ]\Core\Runtime\SP3DCoCreateInstance.dll needs to be referenced in the Visual Basicproject. Example usage of SP3DCreateObject is shown below:

Set oHel perObj ect = SP3DCr eat eObj ect ( st r Hel perProgI d)

If the symbol class has any public structures or types, they should be made private. Forexample:

Publ i c Type I nput TypeName As St r i ngDescr i pt i on As St r i ngProper t i es As I MSDescr i pt i onPr oper t i esuomVal ue As Doubl e

End Type

Should be changed to:

Pr i vat e Type I nput TypeName As St r i ngDescr i pt i on As St r i ngProper t i es As I MSDescr i pt i onPr oper t i esuomVal ue As Doubl e

End Type

Debugging and maintaining Visual Basic project references, reference DLLs, and binarycompatibility are beyond the scope of this document. Contact your SmartMarine 3D Supportrepresentative if you have questions.


26/64




27/64


S E C T I O N 2

The Compartments.xls workbook contains worksheets that define all of the compartment partclasses, void spaces, load case types, and cargo types that are available in the catalog. Inaddition, 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. Aftermaking 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 ClassesThe delivered compartmentation reference data includes compartment tanks, unknown and voidcompartments, habitable compartments, compartments for cargo and machinery, and shipzones 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 notrepresented 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)

BulkCargoTypeDefines 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 surfaceof 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 ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomCompute.

Description - Part description.

DesignBulkCargoMassMh - Homogenous load in all cargo hold (load dependent input).

DesignBulkCargoMassMhd - Alternate load in all cargo holds (load dependent input).

Compartmentation Part Classes and

Load Case Types


28/64

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 uniqueacross 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 fillinghight: 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 thecompartment.

volume - Volume of compartment.

CmpartZoneCPSThe Head section contains the following parameters (listed in alphabetical order):

MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed inthe Al lCodeLis ts .xls workbook on the Mirror Behavior Option sheet in the CodelistNumber column.

PartDescription - Part description.

PartNumber - Part number or name as it appears in the Catalog task. This identificationmust be unique across the entire catalog.

SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol filedifferent from the SymbolDefinition in the Definition section. The 2D symbol files aredelivered 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):




SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol filedifferent from the SymbolDefinition in the Definition section. The 2D symbol files aredelivered to the [Reference Data]\SharedContent folder.

CmpartZoneFireDefines ship fire zones.




29/64





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 aredelivered to the [Reference Data Product Folder ]\SharedContent folder.

CmpartZonePlanningDefines ship zones for planning.

The Head section contains the following parameters:




SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol filedifferent from the SymbolDefinition in the Definition section. The 2D symbol files aredelivered to the [Reference Data Product Folder ]\SharedContent folder.

Classification - Classification for the part.

CompartmentCargoDefines various cargo compartments.


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 Al lCodeLis ts .xls workbook on the Mirror Behavior Option sheet in the CodelistNumber column.



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 filedifferent from the SymbolDefinition in the Definition section. The 2D symbol files are deliveredto the [Reference Data Product Folder ]\SharedContent folder.

CompartmentHabitableDefines living space compartments.





30/64




functionType - Types of functions for compartments.


PartDescription - Part description. PartNumber - Part number or name as it appears in the Catalog task. This identification

must be unique across the entire catalog.


struc tureType - Types of structure for compartments.


CompartmentMachineryDefines compartments for machinery.










structureType - Types of structure for compartments.SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol filedifferent from the SymbolDefinition in the Definition section. The 2D symbol files are deliveredto the [Reference Data Product Folder ]\SharedContent folder.

CompartmentTankDefines compartment tank specifications.





functionType - Types of functions for compartments. MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in

the Al lCodeLis ts .xls workbook on the Mirror Behavior Option sheet in the CodelistNumber column.




31/64






CompartmentUnknownThe Head section contains the following parameters (listed in alphabetical order):











CompartmentVoidThe Head section contains the following parameters (listed in alphabetical order):











GaseousCargoTypeDefines cargo types for gases.



32/64



Custom Program - Custom program for the cargo type, if needed. The Visual Basic sourcecode for the load custom programs (rules) is delivered in [Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomCompute folder.

density - Thickness of a material (mass per unit volume).


expansion_coefficient - Measurement of swelling or expansion of a composite materialdue to temperature changes or moisture absorption


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 kilogramof a material by 1 degree Centigrade.

thermal_conductivity - Rate at which a material conducts heat.

viscosity - Measured resistance to flow.

LiquidCargoTypeDefines cargo types for liquids.



density - Thickness of a material (mass per unit volume).


expansion_coefficient - Measurement of swelling or expansion of a composite materialdue to temperature changes or moisture absorption.

FreeSurfaceCenter - Free surface center.


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 kilogramof 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.

LoadCaseTypeDefines the type of cargo load.




33/64



LiquidPressure - Fluid pressure per unit area.


SeaPressure - Pressure at sea level.

UnitCargoTypeThe Head section contains the following parameters (listed in alphabetical order):




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 eachother.

stowage_factor - Ratio of weight to stowage space required under normal conditions.

volume - Volume of compartment.

weight - Weight of the compartment.

VoidSpaceDefines volumes set aside for space reservation in a model.





SymbolDefinition - 2D symbol file associated with the part.You can specify a symbol filedifferent from the SymbolDefinition in the Definition section. The 2D symbol files aredelivered to the [Reference Data Folder ]\SharedContent folder.

Compartmentation Load Case and Cargo TypesThe delivered compartmentation reference data includes load case types and cargo types forgases, liquids, and other materials.

Below is a complete listing of all the properties, both common and unique, that you will see on aload 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 listedhere 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.


34/64



Unique Properties

Unique properties appear only for certain classes.

Custom Program - Enter a custom program for the cargo type, if necessary. The Visual Basicsource code for the load custom programs (rules) is delivered in [Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomCompute

folder.

See Also


Compartmentation Cargo RulesThe delivered compartmentation reference data includes cargo rules that can define the load ona 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 onthe 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


CompartmentCargoRuleDefines the load on a compartment based on the type of cargo the compartment is holding.


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.


35/64




36/64


37/64


S E C T I O N 3

The InterferenceZones.xls workbook defines the zones available for interferences in themodel. These zones are similar to interference volumes, but include the ability to construct ACISgeometry. An example of when to use an interference zone is when you want an evacuationpath 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 SheetThe Interference Zone Type sheet in the InterferenceZones.xls workbook defines theinterference zones for compartmentation.

This topic describes the Head/Start/End section of the sheet. For information about theDefinition 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 arelisted in the Al lCodeL is ts .xls workbook on the Mirror Behavior Option sheet in the CodelistNumber column.

Symbol Definition - Type the symbol definition for the part.

Compartments are not represented by symbols, so you do not need to be concerned withsymbol 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 theInterferenceZoneCodeLists.xls workbook on the Interference Type sheet in the CodelistNumber column.

The Type attribute is an occurrence attribute, denoted by oa: in the Definition section of theworksheet.

See Also

Interference Zones (on page 37)

Interference Zones


38/64


39/64


S E C T I O N 4

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 otherrules 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 forcompartmentation.


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 arelisted in the Al lCodeL is ts .xls workbook on the Mirror Behavior Option sheet in the CodelistNumber 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 sectionof this worksheet.

Ship Type - Enter a code for the type of ship. Valid codes are listed in theRegionCodeLists.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 theRegionCodeLists.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 valueis defined internally by the software. Do not modify.

See Also

Regions (on page 39)

Regions


40/64

Regions



41/64


S E C T I O N 5

Compartment volumes, ship zones, interference zones, and regions are not represented by 3Dsymbols, 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 sourcecode, delivered to the [Reference Data ProductFolder ]\Compartmentation\Data\Symbols\Compartmentation\Shapes folder. The files in thisfolder are not used by Compartmentation. This project is for reference and can be used forcustomization purposes.

Delivered symbols include a circle, hexagon, oval, square, and so forth. Bitmaps are providedon the Symbols share, in the SketchCrossSections folder.

Symbol Picture

Circle

Rectangle

Triangle



42/64



Ellipse

Hexagon

Sector

Road

TrapezoidR (right angle)


43/64



TrapezoidC (concentric)

I-Beam

See Also



44/64




45/64


S E C T I O N 6

The CompartGenericServices.xls workbook lists the compartmentation-specific customclasses, interfaces, and attributes that you want in your catalog. This information is necessaryfor the Update Attributes command in the Compartmentation task.

Using custom attributes, you have can control when attributes update and on which objects. Youcan also specify the code that calculates the attribute values.

The CompartGenericServices.xls workbook also provides naming rules for compartments anda 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


Compart Split Rule SheetThe Compart Split Rule sheet in the CompartGenericServices.xls workbook provides a rulethat checks whether compartments overlap.


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. At tr ibute Name - Specifies a descriptive name for the rule. This name is more user-friendly andcan 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 toperform the calculation. The Visual Basic source code for this custom program (rule) is deliveredin [Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplitRule folder.

Query Order - Specifies the order in which the query runs.

See Also

Compartmentation Generic Services (on page 45)

Compartmentation Generic Services


46/64



Compartment Custom Attribute SheetThe Compartment Custom Attribute sheet in the CompartGenericServices.xls workbookdefines custom attributes for compartmentation. You use this information when running theUpdate Attributes command in the Compartmentation task.


Name - Specifies a name for the custom attribute. This name is solely for bulkloading purposesand does not appear on the user interface of the software.

At tr ibute Name - Specifies a descriptive name for the attribute. This name is more user-friendlyand 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 leftblank.

Order - Allows you to use the previously calculated attribute values as a reference to processthe next set of attributes.

Custom Class - Specifies the name of the class associated with the attribute. This class islisted on the Custom Class Interface List sheet in this workbook.

Virtual Interface - Specifies the name of the interface associated with the attribute. Thisinterface 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 tocalculate the attribute. The Visual Basic source code for these rules is delivered in[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute(CompartSemantics) and[Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\Region\CustomCompute(RegionSemantics).

Semantic Contro l - 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


Custom Class Interface List SheetThe Custom Class Interface List sheet in the CompartGenericServices.xls workbook mapsinterfaces to compartmentation classes. You use this information when running the Update At tr ibutes 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



47/64



Naming Rules SheetThe Naming Rules sheet in the CompartGenericServices.xls workbook lists the naming rulesfor compartments.

TypeName - Specifies the internal class names of objects. The type names appear in theCatalog hierarchy under the NamingRules folder.

Name - Specifies the rule name. You can use the same naming rule for more than one objecttype. See Naming Rules (on page 47) for the conventions used by each of thecompartmentation naming rules.

SolverProgID - Lists the ProgID for the naming rule, using the format [project name].[classname]. The Visual Basic source code for compartment naming rules is delivered in the followingfolders:

Compartments (frame rule) - [Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming

Loads - [Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\Naming

General Volumes - [Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Ruless\GeneralVolume\Naming

Load Combinations - [Programming ResourcesFolder]\Programming\ExampleCode\Compartmentation\Rules\LoadCombination\Naming

See Also


Naming RulesThe software provides several options for naming various types of compartmentation objectsthat you can place in the model. In addition to the delivered sample naming rules that aredescribed 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 theselected object. The global workshare location ID is the number assigned in the ProjectManagement task; and the index number is the object placement count. For example, thename 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 thecompartment 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 theindex number is the object placement count. For example, the name Ship-1-0003 represents thethird 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 theselected object. The global workshare location ID is the number assigned in the Project


48/64



Management task; and the index number is the object placement count. For example, the nameShipZoneClass-1-0001 represents the first Ship Zone class object placed in the model atlocation 1. Compartmentation contains the Compartments, Interference Zones, Regions, ShipZone and Void Space classes.

User Defined - Enables you to define the name of the compartment. After selecting this namingrule, type the name in the Name box of the Properties dialog box.


49/64


S E C T I O N 7

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

Labels

The CompartLabels.xls workbook (Report sheet) lists the catalog labels that are available forcompartments. 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 thedelivered 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 andselecting the ToolTips tab. To view a label in the software, you pause the mouse pointer overthe compartment in the model.

Reports

The CompartReports.xls workbook (Report sheet) lists the catalog reports that are availablefor compartments. The delivered reports show compartment attributes, loads, objects inside thecompartments, and so forth. The following table describes the delivered reports.

Report Description

Compartment AttributesReport

Displays a list of compartments and their associatedproperties: part description, volume, surface area, andcenter of gravity coordinates.

CompartPaintingArea Displays the exposed surface area of structuralobjects (plates and profiles) for estimating total paintarea. The report shows the objects which are incontact with the compartment in the following ways:

Overlapping

OutsideAndTouching

InsideAndTouching

Inside

Boundary

If you do not select compartments beforerunning the report, all compartments in the currentwork session are processed.

The underlying report processes include:

Get all the objects which are in touch with each

Compartmentation Labels and Reports


50/64

Compartmentation Labels and Reports


Report Description

compartment.

Get the subtracted geometry of the compartmentand object.

Get the surface area of the subtracted geometry.

Get the coating information of thecompartment(s).

Compartment TightnessReport

Displays a list of compartments and their tightnessproperties: part description, compartment tightness,structural tightness, plate, and plate tightness.

Compartments And ZonesReport

Displays a list of compartments and connected zones.This report includes the type of compartment and typeof zone.

Connected CompartmentsReport

Displays a list of compartments that are adjacent.

Load Combination AndRelations Report Displays a list of load combinations, including theassociated spatial loads, connected compartments,unit loads, and load folders. This report provides aload combination overview.

Objects inside theCompartments

Displays a list of compartments, their partdescriptions, and the objects inside thecompartments. This report requires you to select afilter during runtime.

Spatial Loads And RelationsReport

Displays a list of spatial loads, with associated loadcombinations, 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 RelationsReport

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 partdescriptions 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 ReportsUser's Guide.

See Also



51/64


S E C T I O N 8

The CompartmentCodeLists.xls workbook specifies the compartmentation-specific codelists inyour 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, availablefrom the Help > Printable Guides command.

See Also


Compartmentation Codelists


52/64

Compartmentation Codelists


In This Section

Compart Coating Color Codelist .................................................... 53Compart Coating Process Codelist ............................................... 53Compart Coating Responsibility Codelist ...................................... 53Compart Coating Status Codelist .................................................. 53

Compart Coating Type Codelist..................................................... 53Compartment Authorization Class Codelist ................................... 53Compartment Bulk Cargo Type Codelist ....................................... 53Compartment Bulkhead Tightness Codelist .................................. 53Compartment Capacity Context Codelist ...................................... 53Compartment Cargo Context Codelist ........................................... 54Compartment Coating Applicability Codelist ................................. 54Compartment Coating Certification Codelist ................................. 54Compartment Coating Inspection Codelist .................................... 54Compartment Compartment Group Codelist ................................. 54Compartment Compartment Type Codelist ................................... 54Compartment Contact Ma

Documents

Compartment at i on Reference Data Guide