Comment
    • 21 Sep 2022
    • 1 Minute to read
    • Dark
      Light

    Comment

    • Dark
      Light

    Article Summary

    The Comment Unit allows comments to be placed between hydraulic units to aid documentation within the data file.

    Theory and Guidance

    General

    Comments can be included within the data file using the keyword COMMENT.

    COMMENTS can be placed between hydraulic unit data to aid documentation of the data file. COMMENTS cannot be positioned before the end of the general system parameters data or within the initial conditions. A COMMENT is not a hydraulic unit and should therefore not be included in the number of nodes in the model given in line 2 of the data file.

    Data

    Field in Data Entry Form

    Description

    Name in Datafile

    Comment

    required comment (anything you like except Flood Modeller keywords should not be used at the start of a line, e.g. don't start a line with RIVER)

    text

    Datafile Format

    General

    Line 1 : keyword 'COMMENT'

    Line 2 : n1

    Line 3 to Line 2 + n1 : Text

    where nis the number of lines of ensuing comments, and text is the required comment (anything you like except Flood Modeller keywords should not be used at the start of a line, e.g. don't start a line with RIVER)

    Example

    COMMENT
    2
    Data for node U127 have been increased by 10% 
    This is for sensitivity test purposes

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.