Initial Design Geometry XML File format

tid_geometry

The main root element, which can contain the following elements:

1. description

2. general_particulars

3. compartments

4. surfaces

5. reference_points

These elements are optional.

description

This element contains general text, which typically describes or identifies the data contained in the file.

general_particulars

units

"meters" or "feet"

This contains the following elements:

6. main_dimensions

7. ship_classification

8. frame_table

These elements are optional.

ship_classification

yard_no

Yard Number

This data is typically included in a trim and stability booklet, and is required for classification and approval purposes.

All items are optional and will default to blank, if not given.

imo_number

IMO Number

gross_tonnage

Gross Tonnage

net_tonnage

Net Tonnage

displacement

Displacement

lightship

Lightship

load_draft

Load Draft

company

Company

person

Person responsible

comments

Comments

ship_name

Ship Name

class_number

Class Number

ship_type

Ship type

call_letters

Call letters

flag

Flag

official_number

Official Number

port_of_registry

Port of Registry

manager

Manager

builder

Builder

year_of_build

Year of Build

frame_table

origin_to_frame0

Distance from origin (AP) to frame zero.

This element contains one or more frame_spacing elements.

direction

"forward" or "aft"

modified

Date modified

compartments

units

"meters" or "feet"

This element contains optionally one categories element plus zero or more compartment elements.

surfaces

units

"meters" or "feet"

This element contains one or more surface elements.

categories

This element contains one or more category elements

category

id

Category identifier (required)

Compartment category, used to group compartments having a similar function, for example, water ballast tanks.

name

Description

default_contents

Id of a content type used as the default.

compartment

id

Compartment identifier (required)

This element contains a total_volume element plus optionally min_extent and max_extent elements, plus one of the following elements according to compartment type:

9. faces

10. portions

11. sections

12. calibrations

name

description

type

"facet"

"portion"

"section", or

"calibration"

perm

Structural permeability or allowance (%)

damperm

Damage permeability (%)

buoyant

"true" if part of main hull envelope, otherwise "false"

category

Compartment usage type (see categories element)

modified

Date modified

surface

Id

Surface identifier (required

This element contains a faces element

name

Description

type

trans_bulkhead_facet

"deck_facet", or

"long_bulkhead_facet"

(required)

modified

Date modified

total_volume

Total volume properties of the compartment. Contains one mp element

mp

volume

Volume

Volume properties.

All attributes will default to zero, if not given. For total volume properties, the waterplane area and associated properties will be zero.

lcb

Long. Centroid

tcb

Trans. Centroid

vcb

Vert. Centroid

wp_area

Waterplane area

lcf

Long. Centroid of area

tcf

Trans. Centroid of area

ixx

Trans. 2nd moment of area

iyy

Long. 2nd moment of area

ixy

Polar 2nd moment of area

min_extent

Minimum x,y,z coordinates contained in one vertex element

max_extent

Maximum x,y,z coordinates contained in one vertex element

vertex

x

x-coordinate

3D point.

y

y-coordinate

z

z-coordinate

faces

Contains one of more face elements

face

Contains one vertices element and one facets element, which together describe the triangular facets that make up the face.

vertices

Contains a set of vertex elements

facets

Contains a set of facet elements

facet

i0

Index 0

i0, i1, and i2 are the indices of the points in the set of vertices, that make up the triangular facet. Note that the order is important.

i1

Index 1

i2

Index 2

portions

Contains one or more portion elements

portion

id

Portion id number

Contains 3 section elements.

side

Side indicator:

0 = both sides

1 = port only

2 = stbd. only

fact

Permeability factor

sections

Contains two or more section elements

section

xposition

X position of section

Contains a set of point2d elements.

Note that for sections making up a portion, there must be exactly 3 points.

Otherwise the points in a section must form a closed curve.

point2d

y

y-coordinate

A point in the y,z plane

z

z-coordinate

calibrations

Contains one or more calibration elements. Note that the calibrations should be ordered in increasing sounding measurements.

calibration

sounding

Sounding

Data for one tank sounding.

capacity

Volume at given sounding

lcg

Long. Centroid

tcg

Trans. Centroid

vcg

Vert. Centroid

fsm

Free surface moment

reference_points

units

"meters" or "feet"

Contains one or more of the following elements: unprotected_openings, protected_openings, deck_edge, profile.

unprotected_openings

Contains one or more opening elements.

protected_openings

Contains one or more opening elements.

deck_edge

Contains one or more opening elements.

profile

Contains 3 or more point2d elements.

opening

x

x-coordinate

The compid, compid2 and state attributes are not applicable to deck_edge elements.

The compid2 element is only valid for unprotected_openings.

y

y-coordinate

z

z-coordinate

compid

Id of compartment connected to opening

compid2

Id of 2nd connected compartment

state

Associated readiness states

frame_spacing

from

Frame number to start spacing from

This specifies a frame spacing and the frame number to start the spacing.

spacing

Frame spacing (m)