Command Descriptions and Syntax

Within the descriptions of the commands, the following shorthand notation is used:-

BAY

Purpose

This command is used to define a bay definition for use within the AVEVA Initial Design Hydrostatic module. The bay definition may be created relative to a transverse bulkhead and deck (thus allowing automatic regeneration if the internals are moved) or may be fixed at a specific location along the vessel. The container type, maximum number of tiers and minimum distance to the hull surface may be specified and the bay generated automatically. Alternatively, the number of rows and tiers can be specified by you.

Once generated, any of the bay attributes may be changed and the bay regenerated. Individual rows; tiers or single containers may be removed and additional transverse and vertical gaps may be added to allow for obstructions.

Surfaces may be set up within Surface/Compartment to model such items as cranes. These can be marked as obstructions and are taken into account when automatically generating a bay. In addition, a line-of-sight may be defined which again, when automatically generating the tiers and rows, is used to stop any containers being defined which would obstruct the line of sight.

Finally, a longitudinal bulkhead may be automatically generated from the outlines of a number of bay definitions. Once generated, this can be altered in the usual ways.

Syntax

Description

The Bay command is quite complex and can be used to perform a number of bay definition related functions, namely:

• create a bay definition, either by specifying the rows and tiers or by automatically taking into account the container type and hull shape.

• Set any of the bay properties and optionally regenerate the bay

• Set row and tier names

• Switch off (or back on) individual containers or whole rows/tiers.

• Regenerate a list of (or all) bay definitions

• Display the properties of a list of (or all) bay definitions

• Generate a longitudinal bulkhead from a number of bay definitions

• Create a line of sight for use when automatically generating bay definitions.

Creating a bay definition

Before creating a bay definition, the associated container type must have been generated together with the associated longitudinal and deck, if required. The sight line must also be defined if you wish to use this to limit the height of container tiers.

To create the bay definition, specify the bay name ($W) followed by the Create command and then the following items:

• container type - this must be a valid container type previously defined using the Container command

• X location - the position of the aft point of the bay must be specified. For a fixed bay definition, this can be specified as an absolute value in the current input units. However, the bay location may be specified as a relative value to a transverse bulkhead. In this case the name of the bulkhead is specified and an offset relative to this internal surface. Specifying the bay definition is such a way allows the bay to be automatically regenerated if the location of the bulkhead is changed.

• Z location - the position of the base of the bay definition (that is, the base of the first tier). As with the x-location, an absolute value may be specified or alternatively, a deck name may be given together with an offset from the deck.

• To generate a bay with a known number of tiers and rows, simply specify the number of tiers and the number of containers in each tier

• To automatically generate the rows and tiers, specify the /AUTO option and specify whether the bay has an EVEN, ODD or ANY number of rows, the maximum number of tiers and the minimum distance to the hull (the current envelope).

Modifying an existing bay definition

Having generated a bay, either automatically or simply by specifying the number of tiers & the number of containers on each tier, the bay may be further modified. Firstly, you may modify any of the previously defined values:

• TYPE (ANY!ODD!EVEN) Care should be taken when changing the type of a bay definition, since any gaps that have been set (see later) between two tiers may be placed in different locations due to the central tier being removed or added.

• The transverse bulkhead (if previously defined) may be turned OFF. The offset defined then becomes an absolute offset. Alternatively, a different transverse may be selected as the basis for the bay generation. Any offset previously defined now becomes an offset from the new bulkhead.

• The deck (if previously defined) may be turned OFF. The offset defined then becomes an absolute offset. Alternatively, a different deck may be selected as the basis for the bay generation. Any offset previously defined now becomes an offset from the new deck.

• The container type may be changed

• Size - number of tiers followed by maximum number of rows

• Tier - tier name followed by the number of containers on this tier (must not be greater than the maximum number of rows set using the Size command)

• Minimum distance to the hull

• Maximum number of tiers

Additionally, gaps may be included between two tiers or rows. These gaps are in addition to any gaps caused by the transverse separation or vertical separation of the containers.

Rows and Tier Names

Rows and tiers are given default names. These may be changed by using the RENAME qualifier.

Note:
That, if a name contains any special characters, or if it is simply made up of numerical characters, then the name should be given in quotes.

Switching containers on or off

Having created the bay definition, individual containers, entire rows or entire tiers may be removed from the definition. This is useful for coping with obstructions, although obstructions may be taken care of automatically by flagging any such patches as obstructions prior to generating the bay.

Use the SWITCH identifier followed by:

• TIER $W (ON ! OFF) - to turn an entire tier on or off.

• ROW $W (ON ! OFF) - to turn an entire row on or off.

• CONTAINER $W $W (ON ! OFF) - to turn the container at tier $W; row $W on or off.

Use the Generate command to generate a list or all of the bay definitions. If the /AUTO command qualifier is used, then automatic generation method shall be used, otherwise the number of tiers and rows shall be set to those previously input by you.

Creation of a LBHD from the bay definitions

A cranked longitudinal bulkhead can be generated from the defined bays via the LBHD qualifier followed by the name of the longitudinal and two transverse bulkheads.

The existing bay definitions, that have the display flag set and are positioned between the two transverse bulkheads, are used to generate the longitudinal.

By default a bulkhead is created on the port side, to create one on the starboard side use the qualifier /STBD.

Note:
This is generally for use on bay definitions which are non-symmetrical.

For a symmetric arrangement simply use the /REFLECT qualifier to create both bulkheads at once (the second bulkhead simply being a reflection (of the first) in the XZ plane)..

Sight Line

When generating a bay above the deck, it is often required to provide a line of sight that the containers do not obscure. The SIGHT_LINE identifier can be used to create a line of sight between two points and alternatively switch the sight line ON or OFF during subsequent bay generation.

Command Qualifiers

CATEGORY

Purpose

To create or edit a category.

Syntax

Description

Categories are used to group compartments according to their operational function.

Each category consists of the following definition (in order):

• $W - an identifier (limited to 3 characters).

• $W - a descriptive title (limited to 40 characters).

• $W - a default cargo (content) type. The available cargo types are defined via the CONTENT command.

• $N - a default damage permeability percentage for the category (0 - 100).

• $N - the maximum percentage filling permissible for this compartment category (0 - 100).

Command Qualifiers

CHANGE

Purpose

To change a patch, longitudinal bulkhead, transverse bulkhead, deck or compartment into any other entity.

Syntax

Description

Any of the following objects:

• Patch

• Deck

• Transverse bulkhead

• Longitudinal bulkhead

• Compartment

may to changed to any other type. In this way, you can create an object and easily transform it into, for example, a compartment.

Note:
That the topology of a compartment created in this way may not be present.

Command Qualifiers

COMPARTMENT

Purpose

To generate a compartment.

Syntax

Description

The Compartment command has two distinct functions:

• generation of an individual compartment.

• check for overlapping compartment definitions.

When generating a compartment you must specify the ID (if the ID is already used a unique one will automatically be generated based on the supplied one).

For basic compartments (bounded by six internals), three methods are available:

• sliced (/SLICED) - automatically select the nearest boundaries to a predefined location, specified by the slice plane position. A prerequisite of this method is that two graphics views (in slice mode) displaying any 2 of the 3 orthogonal views (section, waterline or buttock) are open. You should first position the slice plane intersection at a location within the compartment space, prior to issuing the command.

• predefined ($W $W $W $W $W $W) - specify all boundary IDs (remember to use an asterisk, "*", to signify the envelope). By using %AFT, %FORWARD, %LOWER, %UPPER, %PORT or %STARBOARD before a particular boundary ($W), all six need not be given in order, but just those boundaries which aren't the envelope.

  A compartment boundary may be specified by simply giving a position value (equates to defining a planar bulkhead/deck). To specify a positional limit, the value must be qualified by enclosing the value within square brackets [] (and should be encapsulated by double quotes as all strings should be). for example, "[15.6]".

• or interactive (no qualifier - above boundaries not specified) - interactively pick the boundaries in turn, as prompted (forward, lower, upper, starboard then port). It is possible to select the current envelope at any stage by clicking the space bar.

For merged compartments, two methods are available:

• predefined (/MERGED with /POSITIVE $L and optionally /NEGATIVE $L) - specify the list of positive and negative components.

• or interactive (/MERGED) - select (in a graphics view) the compartments to be merged. To define a compartment as negative, hold down the SHIFT key when selecting the compartment.

Optionally the title, permeability and layer can be specified.

Simply using the /OVERLAP qualifier results in the system comparing the sum of the volumes of pairs of compartments against the union of the pair of compartments. If the sum is greater than the union, the compartments are considered to overlap.

Command Qualifiers

CONTAINER

Purpose

This command is used to define a container (or a set of default containers) for use in the container arrangement module. Each container can be defined by simply giving its main dimensions or, for more complex containers, one can be generated from a previously defined patch definition.

Syntax

Description

The Container command can be used to either:

• generate a complete set of default containers (based on the ISO standards).

• create and/or modify a single container definition.

• generate a patch from a container definition (for subsequent modification)

To generate the default containers, simply specify the Defaults command qualifier.

To generate a single container, specify the container name ($W) followed by:

• container dimensions (length, width and height) or

• a patch name (PATCH $W)

Finally, the longitudinal, horizontal and vertical separations must be specified in the current input units.

To modify an existing container, use the Set command qualifier followed by:

• LENGTH - length

• WIDTH - width

• HEIGHT - height

• LONG SEP - longitudinal separation

• TRANS SEP - transverse separation

• VERT_SEP - vertical separation

• VCG FULL - vertical centre of gravity of the container when full

• VCG EMPTY - vertical centre of gravity of the container when empty

• WEIGHT FULL - weight of the container when full

• WEIGHT EMPTY - weight of the container when empty

  Note:
  That the last four items are only required when the ship model has been transferred to the Hydrostatic module, but are a included here for completeness.

• GENERATE PATCH - this is used to create a patch from a container definition. This is the only way to modify the underlying entity.

Command Qualifiers

CONTENT

Purpose

To create or edit a content.

Syntax

Description

In AVEVA Initial Design Hydrostatic, content types are the actual contents loaded into compartments in a particular loading condition. Content types are set up in Compartment as they are assigned to compartment categories.

Each content consists of the following definition (in order):

• $W - an identifier.

• /LIQUID or /SOLID or /GRAIN or /UNTRIMMED - the contents type must be one of 4 available options, for further information see the table below.

• $N - the density.

• $N - the grain angle in degrees (not used by liquid or solid type, so set as zero for these).

• $N - a colour index code, which is used to provide visual clarification in Loading Diagrams.

  Index	Colour	Index	Colour
  1	Green	8	Dk Green
  2	Blue	9	Dk Blue
  3	Yellow	10	Olive
  4	Cyan	11	Turquoise
  5	Magenta	12	Dk Magenta
  6	Gray	13	Dk Gray
  7	Dk Red	-	-

• $N - the percentage permeability of the contents with respect to water ingress in damage (0 - 100). So for the type Liquid this should be zero.

Command Qualifiers

DECK

Purpose

To generate a deck.

Syntax

Description

This command is used for three distinct functions:

• Generating a deck within an enclosed volume. If the command is issued without any parameters then the cursor is used to select the deck height. Optionally the ID, height and layer (on which to store the deck) can be specified.

  The boundaries of the deck can also be specified. If the qualifiers /AFT, /FORWARD, /PORT or /STARBOARD are not used, but the IDs specified simply as $W $W $W $W then they are assumed to be in the order: aft, forward, port and starboard. IDs should be encapsulated by double quotes and an asterisk, "*", used to signify the envelope.

• Marking faces of the hull envelope that constitute the deck form as defined in AVEVA Hull.

• Editing various aspects of the specified deck, such as the position, symmetry flag, sheer and camber points.

Command Qualifiers

DEFINITION

Purpose

For interactive editing of an internal surface.

Syntax

Description

Enables the selection of internal surfaces for interactive editing.

When the command is issued (with any of the parameters), the cursor is used to select the required internal surface.

Command Qualifiers

DELETE

Purpose

Deletes a list of members or all members of a specified object type.

Syntax

Description

Decks, transverse bulkheads, longitudinal bulkheads, compartments, containers, bays, hatches and envelopes can be deleted by giving a list of names of the objects to be deleted. Alternatively the qualifier /ALL can be used to delete all members of a specified type.

Command Qualifiers

DIRECTORY

Purpose

To generate a table of compartment volumes.

Syntax

Description

Creates a simple table of volumes and centers for the requested compartment or compartments.

Command Qualifiers

ENVELOPE

Purpose

To create or edit the envelope definition, set the current working envelope, or transfer an existing internal arrangement to a different envelope.

Syntax

Description

An Envelope definition consists of:

• A Barehull (as a minimum) - the hull form shape.

• A Main Deck - which is used to trim away the upper portion of the Barehull.

• A list of Appendages, modelled surface objects, which are either added (positive components) or subtracted (negative components) from the Barehull. For example a cylinder primitive subtracted to represent a thruster tunnel.

Set the current working envelope using ENVELOPE SET <$W>. All further compartmentation will be applied to this envelope.

The /REPLACE qualifier is used to transfer existing internal elements to a different envelope. A list of internal’s identifiers, all the internal structure in the model or all the internals of another specified envelope can be moved with this command.

Command Qualifiers

EXPORT

Purpose

To output objects from the current datastore in the prescribed file format.

Syntax

Description

An XML file is used in the transfer of the geometry definition to AVEVA Initial Design Hydrostic. It contains the faceted representation of the model’s elements (including surfaces (envelopes), compartments, transverse bulkheads, longitudinal bulkheads and decks) marked for release as Calculation Geometry.

The topology (internal arrangement) of the current design can be exported in two forms. The more comprehensive version is in the form of a macro consisting of the commands listed in this section. The old style file based form (as described in Topology File Structure) has a more limited scope in representing all features of the internal arrangement.

The generated macro maybe edited and imported (via the menu option, FILE \ IMPORT \ TOPLOGY... or run from the Macro Editor) into another design to create a similar internal arrangement.

Command Qualifiers

GENERATE

Purpose

Regenerate internal structural elements.

Syntax

Description

Regenerates bulkheads, decks and compartments using the current working envelope.

All internal structural elements can be regenerated with the /ALL qualifier, or individual elements can be moved by specifying the element's ID.

Command Qualifiers

HATCH

Purpose

Used to define a hatch covering for use in the container arrangement module.

Syntax

Description

The Hatch command is used to create (and subsequently modify) a simple container hatch covering. The hatch can be automatically generated from the location and dimension of an existing bay definition, or may be generated directly.

• CREATE - to create a new hatch with the given name. Three options are then available:

  • BAY - specify the bay name followed by the height and thickness of the hatch

  • PATCH - specify the patch name followed by the x-location and height

  • Simply specify the location and dimensions of the hatch (x-location; height; length, width and thickness) - a simple hatch is defined.

• SET - to set one of the following values:

  • %X - x location

  • LENGTH - length

  • WIDTH - width

  • THICKNESS - thickness

  • HEIGHT - height

  • BAY -the associated bay (the length and width of the hatch are taken from the dimensions of the bay)

Having set any of these values, then the hatch should be regenerated. This can be done by appending the /REGENERATE qualifier to the Set command. Alternatively, having set a number of values the Generate command can be used with a list of hatches, or all defined hatches.

The properties of the hatches (either a list of ALL) can be obtained using the PROPERTIES qualifier.

Command Qualifiers

IMPORT

Purpose

To import an internal surface definition from the prescribed file format.

Syntax

Description

The Topology file contains internal surface data (including the corrugation and stool definition) and compartment definitions in terms of the bounding surfaces and other attributes, as used by Compartment.

The CMP file, which contains simplified internal surface and compartment data, is only of particular interest when migrating existing models from the module Spaces which has been phased out.

Command Qualifiers

LAYER

Purpose

Set the current layer or move objects to a specified layer.

Syntax

Description

By specifying an object type, the command moves some or all of the specified objects to the layer number.

Command Qualifiers

LBHD

Purpose

To generate a longitudinal bulkhead.

Syntax

Description

This command is used for two distinct functions:

• Generating a longitudinal bulkhead within an enclosed volume. If the command is issued without any parameters then the cursor is used to select the longitudinal bulkhead’s position from the centreline.

• Optionally the ID, position and layer (on which to store the longitudinal bulkhead) can be specified. If no name prefix is given to the bulkhead, the default prefix, lb, is used.

• The boundaries of the longitudinal bulkhead can also be specified. If the qualifiers /AFT, /FORWARD, /LOWER or /UPPER are not used, but the IDs specified simply as $W $W $W $W then they are assumed to be in the order: aft, forward, lower and upper. IDs should be encapsulated by double quotes and an asterisk, "*", used to signify the envelope.

• Editing various aspects of the specified longitudinal bulkhead, such as the position, symmetry flag, sheer and camber points.

Command Qualifiers

PROPERTIES

Purpose

Calculates the geometric properties of selected objects.

Syntax

Description

Calculates and outputs the geometric properties for selected entities. If no qualifiers are given an object is selected via the cursor. Alternatively you can specify a list of objects, all objects or all objects of a particular type.

Command Qualifiers

SLICE

Purpose

To view a 'thin slice' of a model at specified orthogonal planes.

Syntax

Description

Will slice any element which intersects the X, Y or Z slice planes. It allows solid volumes to be sliced, enabling elements within the solid to be viewed, identified and manipulated without having to turn the solid off.

Command Qualifiers

TBHD

Purpose

To generate a transverse bulkhead.

Syntax

Description

This command is used for two distinct functions:

• Generating a transverse bulkhead within an enclosed volume. If the command is issued without any parameters then the cursor is used to select the transverse bulkhead’s position.

  Optionally the ID, position and layer (on which to store the transverse bulkhead) can be specified. If no name prefix is given to the bulkhead, the default prefix, tb, is used.

  The boundaries of the longitudinal bulkhead can also be specified. If the qualifiers /LOWER, /UPPER, /PORT or /STARBOARD are not used, but the IDs specified simply as $W $W $W $W then they are assumed to be in the order: lower, upper, port and starboard. IDs should be encapsulated by double quotes and an asterisk, "*", used to signify the envelope.

• Editing various aspects of the specified transverse bulkhead, such as the position, symmetry flag, sheer and camber points.

Command Qualifiers

UPDATE

Purpose

Update the database for the current project.

Syntax

Description

Updates bulkhead and deck information in the database for the current project. The information is written in the form of Reference Surface Objects (RSOs). If there is no current AVEVA Marine project or AVEVA Marine production systems, the command will have no effect.

Command Qualifiers

None

WEIGHT

Purpose

This command is used to set the thickness, density, added weight for brackets, and added weight for stiffeners for any envelope or internal, to perform a preliminary weight analysis based on a zone of interest and to produce a report of the weight analysis.

Syntax

Description

The Weight command can be used to either:

• Set default values of thickness, density, added weight for brackets, stiffeners and accommodation. Additional weight for accommodation is added as weight per area unit.

• Set values of thickness, density, added weight for brackets, stiffeners and accommodation for an envelope or internal.

• Perform a preliminary weight analysis within a zone of interest

• Generate a weight report

Command Qualifiers

XMLEXPORTS

Purpose

Mark or show elements in the model intended for export when generating an XML file.

Syntax

Description

The Toggle option will switch the state of selected items (from ‘off’ to ‘on’ or ‘on’ to ‘off’, depending on the current state). Items which are on, will be faceted and exported when creating an XML file (via FILE \ EXPORT \ XML FILE...).

The SHOW option displays those elements currently marked as on in output field of the Output Window.

Command Qualifiers