Adams Basic Package > Adams View > View Command Language > data_element > data_element create plant state

data_element create plant state

Allows you to create a PLANT STATE element.

Format:

 
data_element create plant state
plant_state_name =
a new plant state
adams_id =
adams_id
comments =
string
variable_name =
an existing variable

Example:

 
data_element create plant state &
plant_state_name =
pstate__1 &
adams_id =
1 &
comments =
"a new plant state element " &
variable_name =
variable_1

Description:

 
Parameter
Value Type
Description
plant_state_name
A New Plant State
Specifies the name of the new plant_state. You may use this name later to refer to this plant_state.
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.
variable_name
An Existing Variable
Specifies an existing variable.

Extended Definition:

1. 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.
2. 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.
3. 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.
4. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant input and output definitions, and in function expressions You may identify a variable by typing its name or by picking it from the screen.
Since variable do not have a geometric position, Adams View displays variable icons at or near the model origin. If the variable icon is not visible on the screen, you must type the name. You may also find it convenient to type the name even if the variable icon is displayed.
If you created the variable by reading an Adams data set, the variable name is the letters VAR followed by the Adams data set variable ID number. The name of Adams VARIABLE/101 is VAR101, for example. If you created the variable during preprocessing, you gave it a name at that time.
If a variable is owned by the default model, you may identify it by entering its name only. If it is not, you must enter its full name.
To identify a variable under a different model, for instance, you may need to enter the model name as well. For example, you may specify variable 'fluid_volume' from model 'hydro' by entering ".hydro.fluid_volume'". If you type a "?", Adams View will list the variable available by default.
You must separate multiple variable names by commas.

Cautions:

1. Adams View will not allow you to have two plant_states with the same full name, so you must provide a unique name.

Tips:

1. If the variable is visible in one of your views, you may identify it by picking on any of the graphics associated with it.
2. You need not separate multiple variable picks by commas.