Appendix B
Criteria file format

The criteria are saved in a Hydromax criteria file with the extension .hcr. The file is a normal PC text file, which may be edited manually so as to generate custom criteria. The typical format of the file is given below:

 

Please refer to the file C:\Program Files\Maxsurf\HMCriteriaHelp\CriteriaHelp.html for a full list of all the parameters for all the different criteria types.

 

Hydromax Criteria File

[units]

LengthUnits           =  m

MassUnits             =  tonne

SpeedUnits            =  kts

AngleUnits            =  deg

GZAreaGMAngleUnits    =  deg

[end]

 

[criterionGroup]

GroupName             =  Specific Criteria

ParentGroupName       =  root

[end]

 

[criterionGroup]

GroupName             =  My Custom Criteria

ParentGroupName       =  root

[end]

 

[criterionGroup]

GroupName             =  STIX input data

ParentGroupName       =  Specific Criteria

[end]

 

[criterion]

Type                  =  CTStdAreaUnderGZBetweenLimits

RuleName              =  STIX input data

CritName              =  GZ area to the lesser of downflooding or…

CritInfo              =  Area under GZ curve between specified heel…

CritInfoFile          =  HMCriteriaHelp\StixHelp.rtf

Locked                =  true

GroupName             =  STIX input data

TestIntact            =  true

TestDamage            =  false

Test                  =  false

Compare               =  GreaterThan

UseLoHeel             =  false

UseEquilibrium        =  true

UseHiHeel             =  false

UseFirstPeak          =  false

UseMaxGZ              =  false

UseFirstDF            =  true

UseVanishingStab      =  true

LoHeel                =  0.0

HiHeel                =  30.0

RequiredValue         =  0.000

[end]

 

[criterion]

Type                  =  CTStdAngleOfVanishingStab

RuleName              =  STIX input data

CritName              =  Angle of vanishing stability

CritInfo              =  Calculates the angle of vanishing stability…

CritInfoFile          =  HMCriteriaHelp\StixHelp.rtf

Locked                =  true

GroupName             =  STIX input data

TestIntact            =  true

TestDamage            =  false

Test                  =  false

Compare               =  GreaterThan

RequiredValue         =  0.0

[end]

 

The file must have “Hydromax Criteria File” in the first row. The first section of the file is the units section and this specifies the units that are to be used in the file. There are two angular units:

AngleUnits

Specifies the units for angular measurements, e.g. range of stability

GZAreaGMAngleUnits

Specifies the angle units used for area under GZ graph and for GM.

 

The criteria then appear after the units section and as many criteria as required may be included. The common parameters for all criteria are as follows:

Type

Describes the type of criterion

RuleName

Text which specifies the rule to which the criterion belongs

CritName

Text which specifies the criterion’s name

CritInfo

Verbose description of the criterion

Locked

Whether the criterion may be edited in Hydromax or not. If Locked is set to true, it is not possible to edit the criterion’s parameters in Hydromax

 

The other parameters that may be set depend on the criterion type. The available criterion types are as follows:

Criteria at equilibrium

 

CTStdEquiAngle

Angle of equilibrium

CTStdEquiFreeboard

Freeboard at equilibrium

CTStdEquiGM

GM at equilibrium

GZ curve criteria

 

CTStdValueOfGMAt

Value of GM at specified heel angle

CTStdValueOfGZAt

Value of GZ at specified heel angle.

CTStdValueOfMaxGZ

Maximum value of GZ in specified range

CTStdRatioOfGZValues

Ratio of two GZ values at specified heel angles.

CTStdAngleOfMaxGZ

Angle at which maximum GZ occurs.

CTStdAngleOfEquilibrium

Angle of equilibrium.

CTStdAngleOfDownflooding

Angle at which first down flooding point is immersed.

CTStdAngleOfVanishingStab

Angle of vanishing stability.

CTStdRangeOfStability

Range of positive stability.

CTStdAreaUnderGZBetweenLimits

Area under GZ curve

CTStdHSCMonoAreaUnderGZBetweenLimits

Area under GZ curve – required area depends on upper limit, linear

CTStdHSCMultiAreaUnderGZBetweenLimits

Area under GZ curve – required area depends on upper limit, exponential

Heeling arm criteria

 

CTStdHeelValueOfGMAtEquilibrium

Value of GM at angle of equilibrium with specified heel arm.

CTStdHeelValueOfGZAtEquilibrium

Value of GZ at angle of equilibrium with specified heel arm.

CTStdHeelValueOfMaxGZAboveHA

 

CTStdHeelRatioOfGZValues

 

CTStdHeelAngleOfMaxGZAboveHA

 

CTStdHeelAngleOfEquilibrium

Angle of equilibrium with specified heel arm. Generic heeling arm

CTStdPassengerCrowdingAngleOfEquilibrium

Angle of equilibrium with specified heel arm. Passenger crowding heeling arm

CTStdHighSpeedTurnAngleOfEquilibrium

Angle of equilibrium with specified heel arm. Turning heeling arm

CTStdDerivedHeelArmAngleOfEquilibrium

Derived wind heeling

CTStdHeelAngleOfVanishingStab

Angle of vanishing stability with specified heel arm.

CTStdHeelRangeOfStability

Range of stability with generic wind heeling arm

CTStdHeelAreaBetweenGZAndHABetweenLimits

Area between GZ curve and heeling arm

CTStdHeelRatioOfAreas1Turning

Area ratio, method 1 using generic heeling arm

CTStdHeelRatioOfAreas1Lifting

Area ratio, method 1 using sin+cos heeling arm

CTStdHeelRatioOfAreas2

Ratio of areas based on US Navy wind heeling criterion.

Multiple heeling arm criteria

 

CTStdMultiHeelRatioOfGZValues

GZ ratio for combined heeling arms

CTStdMultiHeelAngleOfEquilibrium

Angle of equilibrium for combined heeling arms

CTStdMultiHeelAreaBetweenGZAndHABetweenLimits

Area between GZ curve and heeling arm, for combined heeling arms

CTStdMultiHeelRatioOfAreas1Turning

Ratio of areas method 1 for combined heeling arms

Heeling arm, combined criteria

 

CTStdHeelGenericTurning

Combined criteria for turning

CTStdHeelGenericLifting

Combined criteria for lifting of heavy weights

CTStdHeelGenericWindHeeling

Combined angle of equilibrium, ratio of GZ values and ratio of areas criteria for specified heeling arm; based on US Navy wind heeling criterion. Uses generic heeling arm

CTStdHeelWindHeeling

Combined angle of equilibrium, ratio of GZ values and ratio of areas criteria for specified heeling arm; based on US Navy wind heeling criterion. Uses wind heeling arm