Previous Topic

Next Topic

Book Contents

Notation

The notation presented in this chapter is used throughout this document.

Input values are a string, unless the first character is a $, in which case an integer, floating point number or variable is to be provided. In the Tcl language, variable references start with the $ character. Tcl expressions can also be used as input to the commands where the input value is specified by the first character being a $.

Optional values are identified in enclosing <> braces.

When specifying a variable quantity of values, the command line contains (x $values). The number of values required, x, and the types of values, $values, are specified in the description of the command.

An arbitrary number of input values is indicated with the dot-dot-dot notation, i.e. $value1 $value2 ...

The OpenSees interpreter constructs objects in the order they are specified by the user. New objects are often based on previously-defined objects. When specified as an object parameter, a previously-defined object must have already been added to the Domain. This requirement is specified in the description of the command arguments.

Also, and very important:

Do not use greek fonts ANYWHERE in your documentation, not only do they not come out in Html, they are not allowed in tcl, which is where this is important. I recommend spelling out the letters: alpha, beta, gamma, eps (short for epsilon), etc.

I recommend to not use them in your figures either, as you would be unable to refer to them. If you must use them you have to do it very carefully, as it may be okey for internal variables.

Example command:

node $nodeTag (ndm $coords) <-mass (ndf $MassValues)>

This line executes the node command assigns coordinates and masses to a specified node. The $nodeTag argument is an integer tag identifying the node.The coordinate arguments are specified with the parentheses () because the number of arguments is dependent on the definition of the model (ndm): two arguments in 2D and three in 3D.

The mass specification at the node definition is optional. Therefore, it is enclosed in <> braces. The number of mass arguments is also dependent on the model definition, depending on the number of degrees of freedom assigned to a node (ndf).

Previous Topic

Next Topic