xfopt

Contents Functions Index

PDF

xfopt

Purpose

User interface for curve stack pointer objects.

Syntax

 xfopt command
 XF(1).FieldName=FieldValue
 XF(1).command='value'
 XF.check
 r1=XF(1).GetData
 curve=XF(1).GetAsCurve
 XF.save='FileName'

Description

SDT considers data sets in curve, Response data or Shapes at DOFs formats. Handling of datasets is described in the iiplot tutorial which illustrates the use of curve stacks (previously called database wrappers).

ufread and ufwrite also use curve stacks which can be stored as variables. In this case, FEM models can also be stored in the stack.

The use of a stack pointer (obtained with XF=iicom(ci,'curvexf');) has side advantages that further checks on user input are performed.

XF.check verifies the consistency of information contained in all data sets and makes corrections when needed. This is used to fill in information that may have been left blank by the user.

disp(XF) gives general information about the datasets. XF(i).info gives detailed and formatted information about the dataset in XF(i). XF(i) only returns the actual dataset contents.

Object saving is overloaded so that data is retrieved from a iiplot figure if appropriate before saving the data to a mat file.

Object field setting is also overloaded (consistency checks are performed before actually setting a field) This is illustrated by the following example

 [ci,XF]=iiplot
 XF(1)
 XF(1).x='time'; XF(1).x

where XF(1) is a Response data set (with abscissa in field .w, responses in field .xf, ...).

XF(1).x='time' sets the XF(1).x field which contains a structure describing its type. Notice how you only needed to give the 'time' argument to fill in all the information. The list of supported axis types is given using xfopt('_datatype')

XF(1).w=[1:10]' sets the XF(1).w field.

Response data

Response data sets correspond to groups of universal files of type UFF58 that have the same properties (type of measurement, abscissa, units, ...). They are used for identification with idcom while the newer curve format is used for simulation results. They are characterized by the following fields

.w	abscissa values
.xf	response data, one column per response, see section 2.8
.dof	characteristics of individual responses (one row per column in the response data as detailed below)
.fun	general data set options, contain [FunType DFormat NPoints XSpacing Xmin XStep ZValue] as detailed in the ufread section on file format 58.
.idopt	options used for identification related routines (see idopt)
.header	header (5 text lines with a maximum of 72 characters)
.x	abscissa description (see xfopt('_datatype'))
.yn	numerator description (see xfopt('_datatype'))
.yd	denominator description (see xfopt('_datatype'))
.z	third axis description (see xfopt('_datatype'))
.group	(optional) cell array containing DOF group names
.load	(optional) loading patterns used in the data set

The .w and .xf fields contain the real data while other fields give more precisions on its nature.

The .dof field describes DOF/channel dependent options of a MIMO data set. The dof field contains one row per response/DOF with the following information

 [RespNodeID.RespDOFID ExciNodeID.ExciDOFID Address ...
 RespGroupID ExciGroupID FunID LoadCase ZaxisValue]

Standard DOF definitions of the form NodeID.DOFID are introduced in section 7.5. Addresses are integer numbers used to identify columns of xf matrices. Sensor / actuator groups are correspond to the group names given in the group field (this is really only supported by ufread).

The idopt field is used to point to identification options used on the data set. These should point to the figure options ci.IDopt.

The Group field is used to associate a name to the group identification numbers RespGroupID ExciGroupID defined in the .dof columns 4 and 5. These names are saved by ufwrite but currently not used in other parts of the SDT.

The load field describes loading cases by giving addresses of applied loads in odd columns and the corresponding coefficients in even columns. This field is used in test cases with multiple correlated inputs.

Shapes at DOFs

Shapes at DOFs is used to store modeshapes, time responses defined at all nodes, ... and are written to universal file format 55 (response at nodes) by ufwrite. The fields used for such datasets are

.po	pole values, time steps, frequency values ... For poles, see ii_pof which allows conversions between the different pole formats.
.res	residues / shapes (one row per shape). Residue format is detailed in section 2.6.
.dof	characteristics of individual responses (follow link for description).
.fun	function characteristics (see UFF58)
.header	header (5 text lines with a maximum of 72 characters)
.idopt	identification options. This is filled when the data structure is obtained as the result of an idcom call.
.label	string describing the content
.lab_in	optional cell array of names for the inputs
.lab_out	optional cell array of names for the outputs
.group	optional cell group names

_FunType, _DataType, _FieldType

These commands are used internally by SDT. xfopt _FunType returns the current list of function types (given in the format specification for Universal File 58).
label=xfopt('_FunType',type) and type=xfopt('_FunType','label') are two other accepted calls.

xfopt _DataType returns the current list of data types (given in the format specification for Universal File 58). xfopt('_DataType',type) and
xfopt('_DataType','label') are two other accepted calls.

For example XF.x.label='Frequency' or XF.x=18.

Data types are used to characterize axes (abscissa (x), ordinate numerator (yn), ordinate denominator (yd) and z-axis data (z)). They are characterized by the fields

.type	four integers describing the axis function type fun (see list with xfopt('_datatype')), length, force and temperature unit exponents
.label	a string label for the axis
.unit	a string for the unit of the axis

xfopt _FieldType returns the current list of field types.

See also

idopt, id_rm, iiplot, ufread

©1991-2007 by SDTools