data_element modify array x_state_array
Allows you to modify an existing x_state_array.
Format:
data_element modify array x_state_array |
|---|
new_array_name = | an existing array |
array_name = | a new array |
adams_id = | adams_id |
comments = | string |
size = | integer |
Example:
data_element modify array x_state_array & |
|---|
array_name = | array__1 & |
adams_id = | 1 & |
comments = | "modified x-state array" & |
size = | 4 |
Description:
::
Parameter | Value Type | Description |
|---|
array_name | An Existing Array | Specifies the name of an existing array |
new_array_name | A New Array | Specifies the name of the new array. You may use this name later to refer to this array. |
adams_id | Adams_id | Specifies an integer used to identify this element in the Adams data file. |
comments | String | Specifies comments for the object being created or modified. |
size | Integer | Specifies the size of an array. In cases where Adams calculates the SIZE differently from the SIZE that the user supplies, Adams returns an error or warning message. |
Extended Definition:
1. An X_STATE_ARRAY defines a list of state variables (X) associated with system modeling elements such as GSE , LSE , and TFSISO. To use this array, you must reference the array name as the state variable array in a system element definition. You can use each X_STATE_ARRAY with only one systems element in your model. When you define an X_STATE_ARRAY , the only other parameter is SIZE. When you do not specify SIZE , the associated systems element automatically sets the size.
2. Adams View will not allow you to have two arrays with the same full name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be any length. For more information, see
Using Extended Names.
By enclosing the name in double quotes, you may use other printable characters, or start the name with a numeral. If a name contains characters, or starts with a numeral, you must always quote the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or a geometry element) when you CREATE it by changing the name. If you enter just the entity name, then the default parent will be assigned by Adams View. If you type in the full name, then you may over ride the default parent. In most cases, when creating an entity, Adams View will provide a default name. The default name that Adams View provides will specify the parentage that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams View writes an Adams data file for your model. Adams requires that each modeling element be identified by a unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams View will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write an Adams file, Adams View will replace the zero with a unique, internally-generated identifier.
Adams View will permanently store this identifier with the element just as if you had entered it yourself.
Normally, you would let all identifiers default to zero, and Adams View would generate the identifiers for you. You are never required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams Solver data file (.adm) is read into Adams View, all comments associated with a statement (from the end of the previous statement through the end of the current statement) are stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF MODEL COMMENTS'. This string must be uppercase.
When an Adams Solver data file is written, the comments for an object are written before the statement corresponding to the object.
5. For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling element automatically determines the size of the array and checks it against the ARRAY command SIZE parameter value (if given).
For the IC_ARRAY, the SIZE parameter is optional and Adams determines the actual size of the array during parsing, as it counts the NUMBERS values. However, if you provide a value for SIZE , Adams checks the count for consistency.
The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME parameter, the NUMBERS parameters, or the size needed for the associated systems element. Adams View provides the SIZE parameter mainly for user convenience in model creation (it is not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is the STATE_EQUATION_COUNT as defined in the matching ENERAL_STATE_EQUATION definition and Y_OUTPUT_ARRAY size is the OUTPUT_EQUATION_COUNT, as defined in the same GENERAL_STATE_EQUATION definition.